From 505a14fbf1d3e2d187fa009462844e4a9d380d44 Mon Sep 17 00:00:00 2001 From: Coby Chapple Date: Mon, 4 Nov 2013 17:36:23 +0000 Subject: [PATCH 1/4] start reworking README to better articulate some contributing guidelines --- README.md | 99 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 66 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 42f2caa9..2e9087ed 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,74 @@ -# A Collection of Useful .gitignore Templates +# A collection of `.gitignore` templates -That's what we're trying to build. Please contribute -by [forking][fk] and sending a [pull request][pr]. +This is GitHub’s collection of [`.gitignore`][man] file templates. +We use this list to populate the `.gitignore` template choosers available +in the GitHub.com interface when creating new repositories and files. -Also **please** only modify **one file** per commit. This'll -make merging easier for everyone. +For more information about how `.gitignore` files work, and how to use them, +the following resources are a great place to start: -Global gitignores (OS-specific, editor-specific) should go into the -`Global/` directory. +- The [Ignoring Files chapter][chapter] of the [Pro Git][progit] book. +- The [Ignoring Files article][help] on the GitHub Help site. +- The [gitignore(5)][man] manual page. -For more information on gitignore: [gitignore(5)][g5] +[man]: http://git-scm.com/docs/gitignore +[help]: https://help.github.com/articles/ignoring-files +[chapter]: http://git-scm.com/book/en/Git-Basics-Recording-Changes-to-the-Repository#Ignoring-Files +[progit]: http://git-scm.com/book -[fk]: http://help.github.com/forking/ +## Folder structure + +The files in the root directory are for `.gitignore` templates that are +project specific, such as language or framework specific templates. +Global (operating system or editor specific) templates should go into the +[`Global/`](./Global) directory. + +## 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 file* per commit**. This will make merging and + conflict resolution easier for everyone. + +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. + +## Contributing workflow + +Here’s how we suggest you go about proposing a change to this project: + +1. [Fork this project][fork] to your account. +2. [Create a branch][branch] for the change you intend to make. +3. Make your changes to your fork. +4. [Send a pull request][pr] from your fork’s branch to our `master` branch. + +Using the web-based interface to make changes is fine too, and will help you +by automatically forking the project and prompting to send a pull request too. + +[fork]: http://help.github.com/forking/ +[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository [pr]: http://help.github.com/pull-requests/ -[g5]: http://man.cx/gitignore -## Pull Requests +## License -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. - -This ensures we can efficiently go through pull requests -and keep quality high. - -## Global Ignores - -git has a global configuration that applies rules to all of -your projects. For example: - - git config --global core.excludesfile ~/.global_ignore - -... will apply the rules in ~/.global_ignore for all of your repos. - -This is useful if you use an editor (like Emacs) that drops backup files, -or if you work in an environment that generates binary or intermediate -files that are always ignored. +[MIT](./LICENSE). From ede3453e149374104b8a4d8d882720a6899c6020 Mon Sep 17 00:00:00 2001 From: Coby Chapple Date: Tue, 5 Nov 2013 00:01:34 +0000 Subject: [PATCH 2/4] reword one-file-per-commit guideline to be about keeping PRs atomic --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2e9087ed..4e950dc5 100644 --- a/README.md +++ b/README.md @@ -47,8 +47,8 @@ high quality, we request that contributions adhere to the following guidelines. template for that language or framework, rather than to the template for an editor, tool, or operating system. -- **Please only modify *one file* per commit**. This will make merging and - conflict resolution easier for everyone. +- **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. From ad1a26d50df7298b2ee50f465e3c765e39c14a3c Mon Sep 17 00:00:00 2001 From: Coby Chapple Date: Tue, 5 Nov 2013 00:26:19 +0000 Subject: [PATCH 3/4] add a section about not including every template under the sun --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4e950dc5..14042e94 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,12 @@ high quality, we request that contributions adhere to the following guidelines. 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. - + +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. + ## Contributing workflow Here’s how we suggest you go about proposing a change to this project: From 7375f82fac9811ab1ac21e295e2513173814e053 Mon Sep 17 00:00:00 2001 From: Coby Chapple Date: Tue, 5 Nov 2013 16:58:09 +0000 Subject: [PATCH 4/4] extract out new contributing guidelines to CONTRIBUTING.md --- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 918dd5e3..91543ab4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,34 @@ -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. +# Contributing guidelines -This ensures we can efficiently go through pull requests and keep quality high. +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. + +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.