Skip to content

Commit 4da2b21

Browse files
committed
lint: Fold long lines to 100 chars maximum
Signed-off-by: 林博仁(Buo-ren Lin) <Buo.Ren.Lin@gmail.com>
1 parent e81dedb commit 4da2b21

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,33 @@
11
# The Common Pre-commit Framework Configuration Template
22

3-
This project provides a common base of Pre-commit's configuration file(.pre-commit-config.yaml) that should be easily adaptable for most project's with little modifications.
3+
This project provides a common base of Pre-commit's configuration file(.pre-commit-config.yaml)
4+
that should be easily adaptable for most project's with little modifications.
45

56
[![Continuous Integration(CI) Status Badge](https://cloud.drone.io/api/badges/Lin-Buo-Ren/common-precommit-config-template/status.svg "Continuous Integration(CI) Status")](https://cloud.drone.io/Lin-Buo-Ren/common-precommit-config-template)
67

78
## How to use
89

9-
* Copy the [common.pre-commit-config.yaml](common.pre-commit-config.yaml) file to your preferred location as .pre-commit-config.yaml
10-
* Download the source code and run [Installer.bash](Installer.bash) program to setup template files for desktop environments. If you specify a directory as argument it will install the template file to the directory instead.
10+
* Copy the [common.pre-commit-config.yaml](common.pre-commit-config.yaml) file to your preferred
11+
location as .pre-commit-config.yaml
12+
* Download the source code and run [Installer.bash](Installer.bash) program to setup template
13+
files for desktop environments. If you specify a directory as argument it will install the
14+
template file to the directory instead.
1115

1216
## License
1317

14-
This template uses [the Creative Commons Attribution-ShareAlike License, version 4.0](https://creativecommons.org/licenses/by-sa/4.0), or any more recent version of your choice, with an exception of the license only covers the configuration file itself, but not other assets in your project.
18+
Unless otherwise specified, this product is released with [the Creative Commons Attribution-ShareAlike License,
19+
version 4.0](https://creativecommons.org/licenses/by-sa/4.0), or any more recent version of your choice, with an
20+
exception of the license only covers the configuration file itself, but not other assets in your project.
1521

1622
For the attribution requirement, please retain the "This file is based on ..." mention and link to this project.
23+
24+
### Identify licenses applicable to a certain product/development asset
25+
26+
If the asset is in plaintext format:
27+
28+
1. Check the `SPDX-License-Identifier` tag in the file's header
29+
1. Check the [.reuse/dep5](.reuse/dep5) file from the source tree/release tree directory
30+
31+
If the asset is not in plaintext format:
32+
33+
Check the [.reuse/dep5](.reuse/dep5) file from the source tree/release tree directory

0 commit comments

Comments
 (0)