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: 3 additions & 1 deletion _articles/best-practices.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Best Practices for Maintainers
description: How to make your life easier as an open source maintainer, from documenting processes to leveraging your community.
description: A guide to making your life easier as an open source maintainer, from documenting processes to leveraging your community.
toc:
documenting-your-processes: "Documenting your processes"
communicate-your-expectations: "Communicate your expectations"
Expand All @@ -10,6 +10,8 @@ toc:
its-okay-to-hit-pause: "It’s okay to hit pause"
---

## Maintaining a project requires more than code

If you maintain an open source project that a lot of people use, you may have noticed a lot of your work is administrative: triaging issues, responding to questions, managing a roadmap.

While these tasks can be less fun than coding or writing, there are ways to make your life easier, from documenting processes to leveraging your community.
Expand Down
4 changes: 1 addition & 3 deletions _articles/building-community.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
---
title: Building Welcoming Communities
description: Building a welcoming community will encourage people to use, contribute to, and evangelize your project.
description: You've launched your project, you're spreading the word, and people are checking it out. Awesome! Now, how do you get them to stick around? Building a welcoming community will encourage people to use, contribute to, and evangelize your project.
toc:
setting-your-project-up-for-success: "Setting your project up for success"
give-your-community-a-place-to-congregate: "Give your community a place to congregate"
growing-your-community: "Growing your community"
resolving-conflicts: "Resolving conflicts"
---

You've launched your project, you're spreading the word, and people are checking it out. Awesome! Now, how do you get them to stick around? Building a welcoming community will encourage people to use, contribute to, and evangelize your project.

## Setting your project up for success

If your project is just starting to see its first contributions, start by giving early contributors a positive experience and make it easy for them to keep coming back.
Expand Down
2 changes: 2 additions & 0 deletions _articles/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ toc:
enforcing-your-code-of-conduct: "Enforcing your code of conduct"
---

## Why do I need a code of conduct?

A code of conduct is a document that establishes expectations for behavior for your project's participants. Adopting, and enforcing, a code of conduct can help create a positive social atmosphere for your community.

Codes of conduct help protect not just your participants, but yourself. If you maintain a project, you may find that unproductive attitudes from other participants can make you feel drained or unhappy about your work over time.
Expand Down
2 changes: 2 additions & 0 deletions _articles/finding-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ toc:
build-a-reputation: "Build a reputation"
---

## Spreading the word

You've just published an open source project. If you'd like others to find and use your project, then it's time to tell everybody about your hard work!

There's no rule that says you have to promote an open source project when you launch. There are many fulfilling reasons to work in open source that have nothing to do with popularity. If you don't want a lot of people to discover or use your project, then go on and keep being your awesome self.
Expand Down
2 changes: 0 additions & 2 deletions _articles/getting-paid.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ toc:
building-a-case-for-financial-support: "Building a case for financial support"
---

Whether you make regular, substantial contributions to open source, or you're just considering your first contribution, you may start to wonder whether anybody gets paid to work on open source.

## Why some people seek financial support

Much of 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 started [Python](https://github.com/python) over a Christmas holiday?)
Expand Down
4 changes: 0 additions & 4 deletions _articles/how-to-contribute-to-open-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ toc:
what-happens-after-you-submit-a-contribution: "What happens after you submit a contribution"
---

Contributing to open source can be a rewarding way to learn, teach, and build experience in just about any skill you can imagine.

In this guide, you’ll learn why people contribute, how they contribute, and strategies for finding and making your first contribution.

## Why contribute to open source?
> Working on [freenode] helped me earn many of the skills I later used for my studies in university and my actual job. I think working on open source projects helps me as much as it helps the project! -@errietta, ["Why I love contributing to open source software"](https://www.errietta.me/blog/open-source/)

Expand Down
2 changes: 2 additions & 0 deletions _articles/leadership-and-governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ toc:
do-i-need-a-legal-entity-to-support-my-project: "Do I need a legal entity to support my project?"
---

## Understanding leadership for your growing project

Your project is growing, people are engaged, and you're committed to keeping this thing going. At this stage, you may be wondering how to incorporate regular project contributors into your workflow.

Maybe you want to give commit access to someone who's made significant contributions. Maybe you got into a debate with a community member and realized you didn't know how to resolve it.
Expand Down
2 changes: 2 additions & 0 deletions _articles/legal.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ toc:
what-does-my-companys-legal-team-need-to-know: "What does my company’s legal team need to know?"
---

## Understanding the legal implications of open source

Sharing your creative work with the world can be an exciting and rewarding experience. It can also mean a bunch of legal things you didn't know you had to worry about.

Thankfully, you don't have to start from scratch. We've got your legal needs covered.
Expand Down
2 changes: 0 additions & 2 deletions _articles/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ toc:
maintainer-health: "Maintainer Health"
---

Your project is starting to grow. 🌱 Well, you think it's growing. Is it growing? Let's talk about how to measure and track the success of your open source project.

## Why measure anything?

Data, when used wisely, can help you make better decisions as an open source maintainer. For example, data can help you:
Expand Down