diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..a04087be225 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,6 @@ +- [ ] Have you followed the [contributing guidelines](https://github.com/github/opensource.guide/blob/gh-pages/CONTRIBUTING.md)? +- [ ] Have you explained what your changes do, and why they add value to the Guides? + +**Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.** + +----- diff --git a/_articles/building-community.md b/_articles/building-community.md index 73d27a2364e..edb4790a106 100644 --- a/_articles/building-community.md +++ b/_articles/building-community.md @@ -29,7 +29,7 @@ Start with your documentation: * **Make it easy for someone to use your project.** [A friendly README](../starting-a-project/#writing-a-readme) and clear code examples will make it easier for anyone who lands on your project to get started. * **Clearly explain how to contribute**, using [your CONTRIBUTING file](../starting-a-project/#writing-your-contributing-guidelines) and keeping your issues up-to-date. -Good documentation invites people to interact with your project. Eventually, someone will open an issue or pull request. Use these interactions as opportunities to move them down the funnel. +[GitHub's 2017 Open Source Survey](http://opensourcesurvey.org/2017/) showed incomplete or confusing documentation is the biggest problem for open source users. Good documentation invites people to interact with your project. Eventually, someone will open an issue or pull request. Use these interactions as opportunities to move them down the funnel. * **When someone new lands on your project, thank them for their interest!** It only takes one negative experience to make someone not want to come back. * **Be responsive.** If you don't respond to their issue for a month, chances are, they've already forgotten about your project. diff --git a/_articles/code-of-conduct.md b/_articles/code-of-conduct.md index afbeef202fa..58ac7eae900 100644 --- a/_articles/code-of-conduct.md +++ b/_articles/code-of-conduct.md @@ -34,7 +34,7 @@ Wherever you can, use prior art. The [Contributor Covenant](http://contributor-c The [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Citizen Code of Conduct](http://citizencodeofconduct.org/) are also two good code of conduct examples. -Place a CODE_OF_CONDUCT file in your project's root directory, and link to it from your README, so it's visible to your community. +Place a CODE_OF_CONDUCT file in your project's root directory, and make it visible to your community by linking it from your CONTRIBUTING or README file. ## Deciding how you'll enforce your code of conduct diff --git a/_articles/finding-users.md b/_articles/finding-users.md index f430041280c..63f51f986b5 100644 --- a/_articles/finding-users.md +++ b/_articles/finding-users.md @@ -1,5 +1,5 @@ --- -title: Finding Users For Your Project +title: Finding Users for Your Project description: Help your open source project grow by getting it in the hands of happy users. class: finding toc: diff --git a/_articles/how-to-contribute.md b/_articles/how-to-contribute.md index b9bc9908ef8..dc71105d637 100644 --- a/_articles/how-to-contribute.md +++ b/_articles/how-to-contribute.md @@ -210,9 +210,10 @@ You might scan a README and find a broken link or a typo. Or you're a new user a > [28% of casual contributions](http://www.igor.pro.br/publica/papers/saner2016.pdf) to open source are documentation, such as a typo fix, reformatting, or writing a translation. -You can also use one of the following resources to help you discover new projects: +You can also use one of the following resources to help you discover and contribute to new projects: * [GitHub Explore](https://github.com/explore/) +* [Open Source Friday](https://opensourcefriday.com) * [First Timers Only](http://www.firsttimersonly.com/) * [Your First PR](https://yourfirstpr.github.io/) * [CodeTriage](https://www.codetriage.com/) diff --git a/_articles/legal.md b/_articles/legal.md index 022f9b45ca1..52c56d332db 100644 --- a/_articles/legal.md +++ b/_articles/legal.md @@ -96,7 +96,7 @@ Probably not. For the vast majority of open source projects, an open source lice An additional contributor agreement -- often called a Contributor License Agreement (CLA) -- can create administrative work for project maintainers. How much work an agreement adds depends on the project and implementation. A simple agreement might require that contributors confirm, with a click, that they have the rights necessary to contribute under the project open source license. A more complicated agreement might require legal review and sign-off from contributors' employers. -Also, by adding "paperwork" that some believe is unnecessary, hard to understand, or unfair (when the agreement recipient gets more rights than contriubtors or the public do via the project's open source license), an additional contributor agreement may be perceived as unfriendly to the project's community. +Also, by adding "paperwork" that some believe is unnecessary, hard to understand, or unfair (when the agreement recipient gets more rights than contributors or the public do via the project's open source license), an additional contributor agreement may be perceived as unfriendly to the project's community.