Skip to content

Commit

Permalink
Merge branch 'gh-pages' into upgrade-primer
Browse files Browse the repository at this point in the history
  • Loading branch information
Sophie Shepherd committed Jul 20, 2017
2 parents 5473cb9 + 567d254 commit e1e54fa
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 12 deletions.
6 changes: 6 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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.**

-----
2 changes: 1 addition & 1 deletion _articles/building-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion _articles/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion _articles/finding-users.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
3 changes: 2 additions & 1 deletion _articles/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand Down
4 changes: 2 additions & 2 deletions _articles/legal.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<aside markdown="1" class="pquote">
<img src="https://avatars1.githubusercontent.com/u/328614?v=3&s=460" class="pquote-avatar" alt="avatar">
Expand Down Expand Up @@ -125,7 +125,7 @@ For better or worse, consider letting them know even if it's a personal project.

* **Third party material:** Does your project have dependencies created by others or otherwise include or use others' code? If these are open source, you'll need to comply with the materials' open source licenses. That starts with choosing a license that works with the third party open source licenses (see above). If your project modifies or distributes third party open source material, then your legal team will also want to know that you're meeting other conditions of the third party open source licenses such as retaining copyright notices. If your project uses others' code that doesn't have an open source license, you'll probably have to ask the third party maintainers to [add an open source license](https://choosealicense.com/no-license/#for-users), and if you can't get one, stop using their code in your project.

* **Trade secrets:** Consider whether there is anything in the project that the company does not want to make available to the general public. If so, you could open source the rest of your project, after extracting the material the you want to keep private.
* **Trade secrets:** Consider whether there is anything in the project that the company does not want to make available to the general public. If so, you could open source the rest of your project, after extracting the material you want to keep private.

* **Patents:** Is your company applying for a patent of which open sourcing your project would constitute [public disclosure](https://en.wikipedia.org/wiki/Public_disclosure)? Sadly, you might be asked to wait (or maybe the company will reconsider the wisdom of the application). If you're expecting contributions to your project from employees of companies with large patent portfolios, your legal team may want you to use a license with an express patent grant from contributors (such as Apache 2.0 or GPLv3), or an additional contributor agreement (see above).

Expand Down
8 changes: 8 additions & 0 deletions assets/js/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,11 @@

$(selector).wrapInner('<span/>');
})();

(function() {
var FRIDAY = 5;
var today = new Date();
if (FRIDAY == today.getDay()) {
$("#opensourcefriday").show();
}
})();
4 changes: 4 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ <h1 class="alt-h1">Open Source Guides</h1>
<p class="alt-lead text-gray mb-md-5 col-md-8 mx-auto">
Open source software is made by people just like you. Learn how to launch and grow your project.
</p>
<p class="alt-lead" id="opensourcefriday" style="display:none">
It's Friday! Invest a few hours contributing to the software you use and love:
<a href='https://opensourcefriday.com'>opensourcefriday.com</a>
</p>
</div>
</header>

Expand Down
6 changes: 0 additions & 6 deletions search.html

This file was deleted.

0 comments on commit e1e54fa

Please sign in to comment.