Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions getting-started/branding.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ It isn’t necessary to write a style guide for your project when you’re just

We’re almost there! Next, we’ll walk you through a few components that every open source project should include when you launch.

### Footnotes
## Footnotes

[1] [http://writing.jan.io/2015/11/20/sustainable-open-source.html](http://writing.jan.io/2015/11/20/sustainable-open-source.html)

### Further reading
## Further reading

* [http://producingoss.com/en/getting-started.html#choosing-a-name](http://producingoss.com/en/getting-started.html#choosing-a-name)
2 changes: 1 addition & 1 deletion getting-started/legal.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ If you use others’ open source code to create anything that could be considere

To learn more about the implications of different open source licenses, [TLDRLegal](https://tldrlegal.com/) is a great resource.

### Further reading
## Further reading

* [http://choosealicense.com](http://choosealicense.com)
* [https://tldrlegal.com/](https://tldrlegal.com/)
Expand Down
2 changes: 1 addition & 1 deletion getting-started/preparing.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Launching your project is only the first step. If you’re hoping people will di

Sometimes, it will take a long time before people notice your open source project. Your project will likely go through multiple phases of activity and contributorship. That’s okay! Some of the most popular projects today took years to reach high levels of activity. The rest of this handbook is designed to help you manage your project every step of the way.

### Further reading
## Further reading

* Licenses
* [https://github.com/blog/1530-choosing-an-open-source-license](https://github.com/blog/1530-choosing-an-open-source-license)
Expand Down
4 changes: 2 additions & 2 deletions marketing/building-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ For casual or first-time contributors, be open-minded about the types of contrib

You’re doing great so far! Now that you’re promoting your project and growing a community, you’re probably wondering whether you’re doing it right. In the next section, we’ll talk about metrics to measure your project’s success and how to track them.

### Footnotes
## Footnotes

[1] [https://docs.google.com/presentation/d/1hsJLv1ieSqtXBzd5YZusY-mB8e1VJzaeOmh8Q4VeMio/edit#slide=id.g43d857af8_0177](https://docs.google.com/presentation/d/1hsJLv1ieSqtXBzd5YZusY-mB8e1VJzaeOmh8Q4VeMio/edit#slide=id.g43d857af8_0177)

[2] [https://speakerdeck.com/mikemcquaid/the-open-source-contributor-funnel](https://speakerdeck.com/mikemcquaid/the-open-source-contributor-funnel)

### Further reading
## Further reading

* [http://radek.io/2015/10/12/marketing-for-open-source-projects-5/](http://radek.io/2015/10/12/marketing-for-open-source-projects-5/)

Expand Down
2 changes: 1 addition & 1 deletion marketing/measuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Here are a few types of contributor metrics you may want to regularly keep track

* **Types of contributions:** For example, commits, fixing typos or bugs, or commenting on an issue.

### Further reading
## Further reading

* [http://blog.smartbear.com/news/measuring-success-in-an-open-source-project/](http://blog.smartbear.com/news/measuring-success-in-an-open-source-project/)

Expand Down
4 changes: 2 additions & 2 deletions marketing/spreading-word.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ Spreading the word is an important step in growing the popularity of your projec

In the next section, we’ll talk about how to retain those early enthusiasts and grow an engaged community around your project.

### Footnotes
## Footnotes

[1] [https://news.ycombinator.com/item?id=7531689](https://news.ycombinator.com/item?id=7531689)

[2] [https://github.com/swinton/codeconf/blob/master/the-hashicorp-formula-to-open-source.md](https://github.com/swinton/codeconf/blob/master/the-hashicorp-formula-to-open-source.md)

### Further reading
## Further reading

* [https://hacks.mozilla.org/2013/05/how-to-spread-the-word-about-your-code/](https://hacks.mozilla.org/2013/05/how-to-spread-the-word-about-your-code/)

Expand Down
4 changes: 4 additions & 0 deletions script/test-prose
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ var options = {
"no-html": false, // Sadly, need HTML for video embeds
"no-heading-punctuation": false,
"list-item-spacing": false,
"first-heading-level": 2, // Page title is h1, so start with h2

// FIXME: Eventually remove these
"maximum-heading-length": 80,
},
"readability": {
"age": 18
Expand Down
4 changes: 2 additions & 2 deletions sustaining/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,15 @@ If you want to get a little more advanced, style guides and linters can help sta

Hopefully, you’re feeling more empowered to say no, set and enforce rules, and take breaks when you need them. In the next section, we’ll talk about how you can leverage your community to grow a sustainable project.

### Footnotes
## Footnotes

[1] [https://lord.io/blog/2014/oss-tips/](https://lord.io/blog/2014/oss-tips/)

[2] [https://twitter.com/solomonstre/status/715277134978113536](https://twitter.com/solomonstre/status/715277134978113536)

[3] [https://blog.jessfraz.com/post/the-art-of-closing/](https://blog.jessfraz.com/post/the-art-of-closing/)

### Further reading
## Further reading

* [http://www.kennethreitz.org/essays/be-cordial-or-be-on-your-way](http://www.kennethreitz.org/essays/be-cordial-or-be-on-your-way)

Expand Down
4 changes: 2 additions & 2 deletions sustaining/healthy-communities.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Do your best to adopt a zero-tolerance policy towards these types of people. If

When you see negative behavior happening on your project, call it out publicly. Explain, in a kind but firm tone, why their behavior is not acceptable. If the problem persists, you may need to [ask them to leave](../../troubleshooting/conduct/). Your code of conduct can be a constructive guide for these conversations.

### Footnotes
## Footnotes

[1] [http://gustavopinto.org/lost+found/saner2016.pdf](http://gustavopinto.org/lost+found/saner2016.pdf)

Expand All @@ -67,7 +67,7 @@ When you see negative behavior happening on your project, call it out publicly.

[6] [https://peerj.com/preprints/1233.pdf](https://peerj.com/preprints/1233.pdf)

### Further reading
## Further reading

* [https://opensource.com/life/16/5/growing-contributor-base-modern-open-source](https://opensource.com/life/16/5/growing-contributor-base-modern-open-source)

Expand Down
2 changes: 1 addition & 1 deletion sustaining/leadership.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Congratulations on making it this far, and welcome to the ranks of open source m

As you grow into your leadership role, you'll inevitably come across some tough situations. Check out our [Troubleshooting](../../troubleshooting/) section for help when you need it. And from the bottom of our hearts, thank you for sharing your work and making a positive contribution to the world. 💕

### Footnotes
## Footnotes

[1] [http://felixge.de/2013/03/11/the-pull-request-hack.html](http://felixge.de/2013/03/11/the-pull-request-hack.html)

Expand Down
4 changes: 2 additions & 2 deletions troubleshooting/conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ Banning members should not be taken lightly and represents a permanent and irrec

It’s not always easy to enforce your code of conduct, but this type of work is necessary to maintain a healthy and active community. When a project seems hostile or unwelcoming, even if it’s just one person whose behavior is tolerated by the rest of the community, you risk losing the contributions of many others, some of whom you may never even meet.

### Footnotes
## Footnotes

[1] [https://github.com/dib-lab/khmer/blob/master/CODE_OF_CONDUCT.rst](https://github.com/dib-lab/khmer/blob/master/CODE_OF_CONDUCT.rst)

### Further reading
## Further reading

* [https://www.djangoproject.com/conduct/enforcement-manual/](https://www.djangoproject.com/conduct/enforcement-manual/)

Expand Down
2 changes: 1 addition & 1 deletion troubleshooting/finding-consensus.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ With a good attitude and clear communication, most difficult situations are reso

Your tiebreaker should be a last resort. Divisive issues can be an opportunity for your community to grow and learn. Embrace these opportunities and try to use a collaborative process to move to a resolution wherever possible.

### Further reading
## Further reading

* [http://producingoss.com/en/producingoss.html#common-pitfalls](http://producingoss.com/en/producingoss.html#common-pitfalls)

Expand Down
10 changes: 5 additions & 5 deletions troubleshooting/getting-paid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ If you make regular, substantial contributions to open source, or you’re just

Today, some open source work is paid. Projects sometimes raise money from companies, individuals, or others to fund ongoing work. [Ruby Together](https://rubytogether.org/), for example, is a foundation that pays for work on [bundler](https://github.com/bundler/bundler), [RubyGems](https://github.com/rubygems/rubygems), and other Ruby infrastructure projects.

For an individual contributor, a company may hire an employee to work on an open source project, or encourage employees to make open source contributions during work hours. [Nodesource](https://github.com/nodesource) and [Rackspace](https://blog.rackspace.com/rackspaces-policy-on-contributing-to-open-source/) are two companies with these types of arrangements.
For an individual contributor, a company may hire an employee to work on an open source project, or encourage employees to make open source contributions during work hours. [Nodesource](https://github.com/nodesource) and [Rackspace](https://blog.rackspace.com/rackspaces-policy-on-contributing-to-open-source/) are two companies with these types of arrangements.

Other open source work is unpaid or volunteered. For example, someone might come across a bug in a project they use and submit a quick fix, or they might enjoy tinkering with an open source project in their spare time. (Did you know that [@gvanrossum ](https://github.com/gvanrossum)started [Python](https://github.com/python) over a Christmas holiday?)

Expand All @@ -26,12 +26,12 @@ As open source’s popularity increases, availability of funding has not yet cau

If you’d like to explore other different funding options, you can check out [this list](https://github.com/nayafia/lemonade-stand). Different types of funding require different skills, so consider your strengths to figure out which funding option works best for you.

### Further reading
## Further reading

* [http://lifeofaudrey.com/essays/love_and_money.html](http://lifeofaudrey.com/essays/love_and_money.html)
* [http://lifeofaudrey.com/essays/love_and_money.html](http://lifeofaudrey.com/essays/love_and_money.html)

* [http://blog.cocoapods.org/Why-we-dont-accept-donations/](http://blog.cocoapods.org/Why-we-dont-accept-donations/)
* [http://blog.cocoapods.org/Why-we-dont-accept-donations/](http://blog.cocoapods.org/Why-we-dont-accept-donations/)

* [http://marijnhaverbeke.nl/blog/sustainable-maintenance.html](http://marijnhaverbeke.nl/blog/sustainable-maintenance.html)
* [http://marijnhaverbeke.nl/blog/sustainable-maintenance.html](http://marijnhaverbeke.nl/blog/sustainable-maintenance.html)

* [https://medium.com/open-source-life/money-and-open-source-d44a1953749c#.nyk44wmm1](https://medium.com/open-source-life/money-and-open-source-d44a1953749c#.nyk44wmm1)