|
2 | 2 |
|
3 | 3 | We’d love you to help us improve this project. To help us keep this collection |
4 | 4 | high quality, we request that contributions adhere to the following guidelines. |
| 5 | +Any contributions that don't meet any of these guidelines will be closed. |
5 | 6 |
|
6 | 7 | - **Provide a link to the application or project’s homepage**. Unless it’s |
7 | 8 | extremely popular, there’s a chance the maintainers don’t know about or use |
8 | 9 | the language, framework, editor, app, or project your change applies to. |
9 | 10 |
|
| 11 | +- **Provide a reason for making this change**. Even if it seems self-evident, |
| 12 | + please take a sentence or two to tell us why your change or addition should |
| 13 | + happen. It’s especially helpful to articulate why this change applies to |
| 14 | + *everyone* who works with the applicable technology, rather than just you or |
| 15 | + your team. |
| 16 | + |
10 | 17 | - **Provide links to documentation** supporting the change you’re making. |
11 | 18 | Current, canonical documentation mentioning the files being ignored is best. |
12 | 19 | If documentation isn’t available to support your change, do the best you can |
13 | 20 | to explain what the files being ignored are for. |
14 | 21 |
|
15 | | -- **Explain why you’re making a change**. Even if it seems self-evident, please |
16 | | - take a sentence or two to tell us why your change or addition should happen. |
17 | | - It’s especially helpful to articulate why this change applies to *everyone* |
18 | | - who works with the applicable technology, rather than just you or your team. |
19 | | - |
20 | | -- **Please consider the scope of your change**. If your change specific to a |
21 | | - certain language or framework, then make sure the change is made to the |
22 | | - template for that language or framework, rather than to the template for an |
23 | | - editor, tool, or operating system. |
| 22 | +- **Keep scope as limited as possible**. Changes should be as small as possible |
| 23 | + and apply to the most specific gitignore template available for the target |
| 24 | + application. For example: OS-specific ignore rules like `.DS_Store` are not |
| 25 | + accepted anywhere but their specific gitignore, `Global/macOS.gitignore` in |
| 26 | + this case. |
24 | 27 |
|
25 | | -- **Please only modify *one template* per pull request**. This helps keep pull |
| 28 | +- **Only modify *one template* per pull request**. This helps keep pull |
26 | 29 | requests and feedback focused on a specific project or technology. |
27 | 30 |
|
| 31 | +- **Add new rules to the best section**. Please ensure your contribution does |
| 32 | + not create duplicate sections or add rules in places unrelated. |
| 33 | + |
| 34 | +- **No duplicate rules**. It's easy to do, but it creates confusion and |
| 35 | + introduces the risk of one or the other being missed in an update. |
| 36 | + |
28 | 37 | In general, the more you can do to help us understand the change you’re making, |
29 | 38 | the more likely we’ll be to accept your contribution quickly. |
30 | 39 |
|
31 | 40 | If a template is mostly a list of files installed by a particular version of |
32 | 41 | some software (e.g. a PHP framework) then it's brittle and probably no more |
33 | 42 | helpful than a simple `ls`. If it's not possible to curate a small set of |
34 | | -useful rules, then the template might not be a good fit for this collection. |
| 43 | +useful rules, then the template is not a good fit for this collection. |
35 | 44 |
|
36 | 45 | Please also understand that we can’t list every tool that ever existed. |
37 | 46 | Our aim is to curate a collection of the *most common and helpful* templates, |
|
0 commit comments