Skip to content

Instantly share code, notes, and snippets.

@juanbono
Forked from softprops/steps.txt
Created April 10, 2018 00:11
Show Gist options
  • Save juanbono/ab4f42f1b94c65a5dc832c2fcd01e1cc to your computer and use it in GitHub Desktop.
Save juanbono/ab4f42f1b94c65a5dc832c2fcd01e1cc to your computer and use it in GitHub Desktop.
Steps to build an awesome ecosystem
1. have a brilliant idea for something you want to use
2. Stop! Don't start building it.
3. Find a project that does something similar. (This likely exists)
4. Read it's documentation.
* If it has none, learn the project and create some.
* If it does, try to build something with it and document what wasn't clear.
5. If it feels broke. Write some failing tests,
* If possible, fix them, then open a pr
* If not, open a pr with failing tests and get the maintainer to teach you how to fix them
6. Document your process for contributing in a file called CONTIBUTING.md
* If this file exists, improve it
7. Reach out to the project owner and ask how to become a maintainer
8. Start reviewing prs
9. Congrats. You have just created value and not a second or third project
that is under documented, under tested, and under maintained!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment