docs/gitignore
docs/gitignore
1
0
Fork 0
mirror of https://github.com/github/gitignore synced 2024-11-24 12:44:22 +01:00
Code Issues Releases Wiki Activity
95c8bf079c
gitignore/CONTRIBUTING.md
John Vandenberg a47c27d351 Trim trailing whitespace
2018-06-05 11:09:20 +07:00

2.2 KiB
Raw Blame History

Contributing guidelines

We’d love you to help us improve this project. To help us keep this collection high quality, we request that contributions adhere to the following guidelines.

  • Provide a link to the application or project’s homepage. Unless it’s extremely popular, there’s a chance the maintainers don’t know about or use the language, framework, editor, app, or project your change applies to.

  • Provide links to documentation supporting the change you’re making. Current, canonical documentation mentioning the files being ignored is best. If documentation isn’t available to support your change, do the best you can to explain what the files being ignored are for.

  • Explain why you’re making a change. Even if it seems self-evident, please take a sentence or two to tell us why your change or addition should happen. It’s especially helpful to articulate why this change applies to everyone who works with the applicable technology, rather than just you or your team.

  • Please consider the scope of your change. If your change specific to a certain language or framework, then make sure the change is made to the template for that language or framework, rather than to the template for an editor, tool, or operating system.

  • Please only modify one template per pull request. This helps keep pull requests and feedback focused on a specific project or technology.

In general, the more you can do to help us understand the change you’re making, the more likely we’ll be to accept your contribution quickly.

If a template is mostly a list of files installed by a particular version of some software (e.g. a PHP framework) then it's brittle and probably no more helpful than a simple ls. If it's not possible to curate a small set of useful rules, then the template might not be a good fit for this collection.

Please also understand that we can’t list every tool that ever existed. Our aim is to curate a collection of the most common and helpful templates, not to make sure we cover every project possible. If we choose not to include your language, tool, or project, it’s not because it’s not awesome.