|
1 | | -Since this repo includes a large and diverse number of programming languages, frameworks, editors, and ecosystems, it's *very helpful* if you can provide a link to information supporting your pull request. Up-to-date, canonical documentation that mentions the files to be ignored is best. |
| 1 | +# Contributing guidelines |
2 | 2 |
|
3 | | -This ensures we can efficiently go through pull requests and keep quality high. |
| 3 | +We’d love you to help us improve this project. To help us keep this collection |
| 4 | +high quality, we request that contributions adhere to the following guidelines. |
| 5 | + |
| 6 | +- **Provide a link to the application or project’s homepage**. Unless it’s |
| 7 | + extremely popular, there’s a chance the maintainers don’t know about or use |
| 8 | + the language, framework, editor, app, or project your change applies to. |
| 9 | + |
| 10 | +- **Provide links to documentation** supporting the change you’re making. |
| 11 | + Current, canonical documentation mentioning the files being ignored is best. |
| 12 | + If documentation isn’t available to support your change, do the best you can |
| 13 | + to explain what the files being ignored are for. |
| 14 | + |
| 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. |
| 24 | + |
| 25 | +- **Please only modify *one template* per pull request**. This helps keep pull |
| 26 | + requests and feedback focused on a specific project or technology. |
| 27 | + |
| 28 | +In general, the more you can do to help us understand the change you’re making, |
| 29 | +the more likely we’ll be to accept your contribution quickly. |
| 30 | + |
| 31 | +Please also understand that we can’t list every tool that ever existed. |
| 32 | +Our aim is to curate a collection of the *most common and helpful* templates, |
| 33 | +not to make sure we cover every project possible. If we choose not to |
| 34 | +include your language, tool, or project, it’s not because it’s not awesome. |
0 commit comments