|
1 | 1 | # The Common Pre-commit Framework Configuration Template |
2 | 2 |
|
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. |
4 | 5 |
|
5 | 6 | [ Status")](https://cloud.drone.io/Lin-Buo-Ren/common-precommit-config-template) |
6 | 7 |
|
7 | 8 | ## How to use |
8 | 9 |
|
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. |
11 | 15 |
|
12 | 16 | ## License |
13 | 17 |
|
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. |
15 | 21 |
|
16 | 22 | 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