Skip to content
Open
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
2 changes: 1 addition & 1 deletion _articles/en-US/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ If you don't want to accept a contribution:

You shouldn't need more than 1-2 sentences to respond. For example, when a user of [celery](https://github.com/celery/celery/) reported a Windows-related error, @berkerpeksag [responded with](https://github.com/celery/celery/issues/3383):

![celery screenshot](/assets/images/best-practices/celery.png)
![celery screenshot](/assets/images/en-US/best-practices/celery.png)

If the thought of saying no terrifies you, you're not alone. As @jessfraz [put it](https://blog.jessfraz.com/post/the-art-of-closing/):

Expand Down
8 changes: 4 additions & 4 deletions _articles/en-US/building-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ A welcoming community is an investment into your project's future and reputation

One way to think about your project's community is through what @MikeMcQuaid calls the [contributor funnel](https://speakerdeck.com/mikemcquaid/the-open-source-contributor-funnel):

![contributor funnel](/assets/images/building-community/contributor_funnel_mikemcquaid.png)
![contributor funnel](/assets/images/en-US/building-community/contributor_funnel_mikemcquaid.png)

As you build your community, consider how someone at the top of the funnel (a potential user) might theoretically make their way to the bottom (an active maintainer). Your goal is to reduce friction at each stage of the contributor experience. When people have easy wins, they will feel incentivized to do more.

Expand Down Expand Up @@ -81,7 +81,7 @@ Try to be responsive when someone files an issue, submits a pull request, or ask

Even if you can't review the request immediately, acknowledging it early helps increase engagement. Here's how @tdreyno responded to a pull request on [Middleman](https://github.com/middleman/middleman/pull/1466):

![middleman pull request](/assets/images/building-community/middleman_pr.png)
![middleman pull request](/assets/images/en-US/building-community/middleman_pr.png)

[A Mozilla study found that](https://docs.google.com/presentation/d/1hsJLv1ieSqtXBzd5YZusY-mB8e1VJzaeOmh8Q4VeMio/edit#slide=id.g43d857af8_0177) contributors who received code reviews within 48 hours had a much higher rate of return and repeat contribution.

Expand Down Expand Up @@ -131,7 +131,7 @@ Good documentation only becomes more important as your community grows. Casual c

In your CONTRIBUTING file, explicitly tell new contributors how to get started. You may even want to make a dedicated section for this purpose. [Django](https://github.com/django/django), for example, has a special landing page to welcome new contributors.

![django new contributors page](/assets/images/building-community/django_new_contributors.png)
![django new contributors page](/assets/images/en-US/building-community/django_new_contributors.png)

In your issue queue, label bugs that are suitable for different types of contributors: for example, [_"first timers only"_](https://medium.com/@kentcdodds/first-timers-only-78281ea47455#.g1k01jy05), _"good first bug"_, or _"documentation"_. [These labels](https://github.com/librariesio/libraries.io/blob/6afea1a3354aef4672d9b3a9fc4cc308d60020c8/app/models/github_issue.rb#L8-L14) make it easy for someone new to your project to quickly scan your issues and get started.

Expand Down Expand Up @@ -159,7 +159,7 @@ See if you can find ways to share ownership with your community as much as possi

* **Resist fixing easy (non-critical) bugs.** Instead, use them as opportunities to recruit new contributors, or mentor someone who'd like to contribute. It may seem unnatural at first, but your investment will pay off over time. For example, @michaeljoseph asked a contributor to submit a pull request on a [Cookiecutter](https://github.com/audreyr/cookiecutter) issue below, rather than fix it himself.

![cookiecutter issue](/assets/images/building-community/cookiecutter_submit_pr.png)
![cookiecutter issue](/assets/images/en-US/building-community/cookiecutter_submit_pr.png)

* **Start a CONTRIBUTORS or AUTHORS file in your project** that lists everyone who's contributed to your project, like [Sinatra](https://github.com/sinatra/sinatra/blob/master/AUTHORS.md) does.

Expand Down
8 changes: 4 additions & 4 deletions _articles/en-US/finding-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Remember that people get involved as users, and eventually contributors, because

For example, @robb uses code examples to clearly communicate why his project, [Cartography](https://github.com/robb/Cartography), is useful:

![cartography readme](/assets/images/finding-users/cartography.jpg)
![cartography readme](/assets/images/en-US/finding-users/cartography.jpg)

For a deeper diver into messaging, check out Mozilla's ["Personas and Pathways"](http://mozillascience.github.io/working-open-workshop/personas_pathways/) exercise for developing user personas.

Expand Down Expand Up @@ -61,7 +61,7 @@ If you don't wish to set up these channels for your project yet, promote your ow

If your project is hosted on GitHub, you can use [GitHub Pages](https://pages.github.com/) to easily make a website. [Yeoman](http://yeoman.io/), [Vagrant](https://www.vagrantup.com/), and [Middleman](https://middlemanapp.com/) are [a few examples](https://github.com/showcases/github-pages-examples) of excellent, comprehensive websites.

![vagrant homepage](/assets/images/finding-users/vagrant_homepage.png)
![vagrant homepage](/assets/images/en-US/finding-users/vagrant_homepage.png)

Now that you have a message for your project, and an easy way for people to find your project, let's get out there and talk to your audience!

Expand Down Expand Up @@ -91,7 +91,7 @@ If nobody pays attention or responds to your initial outreach, don't get discour

## Go where your project's audience is (offline)

![public speaking](/assets/images/finding-users/public_speaking.jpg)
![public speaking](/assets/images/en-US/finding-users/public_speaking.jpg)

Offline events are a popular way to promote new projects. It's a great way to reach an engaged audience and build deeper human connections, especially if you are interested in reaching developers.

Expand All @@ -110,7 +110,7 @@ If you've never spoken at an event before, it's perfectly normal to feel nervous
As you write your talk, focus on what your audience will find interesting and get value out of. Keep your language friendly and approachable. Smile, breathe, and have fun.

<aside markdown="1" class="pquote">
<img src="/assets/images/finding-users/lena.jpg" class="pquote-avatar" alt="avatar">
<img src="/assets/images/en-US/finding-users/lena.jpg" class="pquote-avatar" alt="avatar">
When you start writing your talk, no matter what your topic is, it can help if you see your talk as a story that you tell people.
<p markdown="1" class="pquote-credit">
— Lena Reinhard, ["How to Prepare and Write a Tech Conference Talk"](http://wunder.schoenaberselten.com/2016/02/16/how-to-prepare-and-write-a-tech-conference-talk/)
Expand Down
2 changes: 1 addition & 1 deletion _articles/en-US/legal.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Finally, your project may have dependencies with license requirements that you w

When you [create a new project](https://help.github.com/articles/creating-a-new-repository/) on GitHub, you have the option to make the repository **private** or **public**.

![create repository](/assets/images/legal/repo-create-name.png)
![create repository](/assets/images/en-US/legal/repo-create-name.png)

**Making your GitHub project public is not the same as licensing your project.** Public projects are covered by [GitHub's Terms of Service](https://help.github.com/articles/github-terms-of-service/#f-copyright-and-content-ownership), which allows others to view and fork your project, but your work otherwise comes with no permissions.

Expand Down
6 changes: 3 additions & 3 deletions _articles/en-US/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ If you _are_ interested in understanding your project on a deeper level, read on

Before anybody can use or contribute back to your project, they need to know it exists. Ask yourself: _are people finding this project?_

![traffic graph](/assets/images/metrics/repo_traffic_graphs_tooltip.png)
![traffic graph](/assets/images/en-US/metrics/repo_traffic_graphs_tooltip.png)

If your project is hosted on GitHub, [you can view](https://help.github.com/articles/about-repository-graphs/#traffic) how many people land on your project and where they come from. From your project's page, click "Graphs", then "Traffic". On this page, you can see:

Expand All @@ -64,7 +64,7 @@ Each package manager may use a slightly different definition of "download", and

If your project is on GitHub, navigate again to the "Traffic" page. You can use the [clone graph](https://github.com/blog/1873-clone-graphs) to see how many times your project has been cloned on a given day, broken down by total clones and unique cloners.

![clone graph](/assets/images/metrics/clone_graph.png)
![clone graph](/assets/images/en-US/metrics/clone_graph.png)

If usage is low compared to the number of people discovering your project, there are two issues to consider. Either:

Expand All @@ -89,7 +89,7 @@ Examples of community metrics that you may want to regularly track include:

* **Total contributor count and number of commits per contributor:** Tells you how many contributors you have, and who's more or less active. On GitHub, you can view this under "Graphs" -> "Contributors." Right now, this graph only counts contributors who have committed to the default branch of the repository.

![contributor graph](/assets/images/metrics/repo_contributors_specific_graph.png)
![contributor graph](/assets/images/en-US/metrics/repo_contributors_specific_graph.png)

* **First time, casual, and repeat contributors:** Helps you track whether you're getting new contributors, and whether they come back. (Casual contributors are contributors with a low number of commits. Whether that's one commit, less than five commits, or something else is up to you.) Without new contributors, your project's community can become stagnant.

Expand Down
4 changes: 2 additions & 2 deletions _articles/en-US/starting-a-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Legal work is no fun. The good news is that you can copy and paste an existing l

When you create a new project on GitHub, you are given the option to select a license. Including an open source license will make your GitHub project open source.

![pick a license](/assets/images/starting-a-project/repository-license-picker.png)
![pick a license](/assets/images/en-US/starting-a-project/repository-license-picker.png)

If you have other questions or concerns around the legal aspects of managing an open source project, [we've got you covered](../legal/).

Expand Down Expand Up @@ -194,7 +194,7 @@ For more help with writing your CONTRIBUTING file, check out @nayafia's [contrib

Link to your CONTRIBUTING file from your README, so more people see it. If you [place the CONTRIBUTING file in your project's repository](https://help.github.com/articles/setting-guidelines-for-repository-contributors/), GitHub will automatically link to your file when a contributor creates an issue or opens a pull request.

![contributing guidelines](/assets/images/starting-a-project/Contributing-guidelines.jpg)
![contributing guidelines](/assets/images/en-US/starting-a-project/Contributing-guidelines.jpg)

### Establishing a code of conduct

Expand Down
Loading