5 keys to project success on GitHub

No readers like this yet.
GitHub logo with navy background

From GitHub

Community-driven software development is becoming the new path to brand and project success. You would be advised to pay attention to this surging trend: With more than 27 million projects currently on GitHub, the ever-increasing popularity of community-driven development is evident.

So, how do you go about engaging this global force of tech wizards?

As co-founder of RethinkDB—an open source, scalable JSON database designed for real time Internet—I've got some thoughts on that. My team and I have created the most starred database on GitHub with thousands of volunteer contributors. The open communication channel on GitHub has helped us deliver the best solutions and create a product used by companies in a variety of industries, including some Fortune 500 companies.

I've come up with five concrete ways you too make your project successful on GitHub. It's all about engaging the community.

1. Prioritize your community

Open source is more than a license and software development model; it's also largely about the people. Encourage both users and maintainers to collaborate to promote a surge in new ideas. You'll find that most prominent projects incorporate a community of contributors with a mailing list, GitHub project, and/or IRC/Slack channel.

2. Welcome new contributors

Contributors often feel intimidated and self-conscious when starting a new project. Help them break out of their shell by offering a set of contribution guidelines and using an issue tracker to highlight troubleshooting that can be easily handled by new contributors. Laying out the proper groundwork is vital to the success of your project. For example, when we launched RethinkDB we also put out a GitHub issue etiquette guide to help users.

3. Appreciate contributors' work

All those who contribute to RethinkDB are co-creators and have ownership over their work on each project. At RethinkDB, we recognize each contributor's input in a variety of ways. Easy things to do that go a long way are shout-outs, a kind note, or sending some swag, like a T-shirt. Contributors help us build RethinkDB in a variety of ways, whether it's submitting a pull request on GitHub or testing a new feature or another task; each of them deserves gratitude from us.

4. Use art to visualize your ideas

Art has a powerful capability to communicate ideas, just like software. Take advantage of graphic design to brand your projects. (We hired a full-time developer to help us.) Consider creating a friendly mascot (like the GitHub Octocat or RethinkDB Thinker) to help distinguish your project for your community. In addition, use art to illustrate and teach complex ideas and instructions. By incorporating art into your project, you may also encourage artistic contributions from your new contributors.

5. Implement documentation to prevent problems

Fastidious recording of your project process can avert potential issues and confusion. Good documentation includes a FAQ section, a set of instructions for common patterns, and a set of examples. You can even make your documentation open source by asking for contributions from those working on your projects.


Accelerate engaging a community of volunteer software developers by making them feel welcome, giving them clear tasks, and establishing tangible ways for them to be completed. Most importantly, thank contributors when they help you. Your project will flourish because of it.

User profile image.
Michael Glukhovsky is the co-founder of RethinkDB.



Great advices. Thanks.

Creative Commons LicenseThis work is licensed under a Creative Commons Attribution-Share Alike 4.0 International License.