Skip to content

How to Contribute

Celso Mireles edited this page Jun 17, 2016 · 1 revision

First, take a look at the open issues. Claim an issue by leaving a comment saying you are going to try to tackle it. If you aren't sure what to work on, look for issues tagged as 'high-priority' and/or 'newbie-friendly'.

Then, commit some code and submit a change to the relevant project! Cosecha projects use Gitflow to accept pull requests. To submit a change to an existing project:

  • Fork the project to your own GitHub account (click "Fork" on the project page in GitHub)
  • Create your feature branch (git checkout -b my-new-feature)
  • Commit your changes (git commit -am 'Add some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create a new Pull Request
  • Each project has a README that (hopefully) explains how to get started and how to run any tests or code validation. You should ensure that your changes use good code style, are appropriately commented, and don't break any tests (if applicable).

If you pick an issue that is a new project from the list of open projects, that's great and we admire your ambition! This is how you can make something that we can use:

  • Make a note on the issue relevant to your project noting that you are working on it.
  • Start working on your own Github account and try to get a prototype running and deploying. We find the easiest way to deploy most things is to use Heroku -- just set up a free account there.
  • Once you have a running prototype, leave a note on the original issue linking to your project and the demo.
  • Set up the labels described above.
  • Add a license to the project. We default to AGPL-v3.0, but we leave it to your discretion.
  • Add a README explaining, at minimum, how to run the project from a fresh clone and how to deploy the project.

Clone this wiki locally