Skip to content

Contributing Guide

Jump to bottom
Seth Vargo edited this page May 6, 2012 · 1 revision

Envelope is open-source. It's ultimate goal is to become a community-maintained project. However, it's currently run and operated by a group of 4 students, and we are not ready to bring more members onto the team just yet.

That being said, we'd love to see what people have to offer. Please follow these guidelines when submitting a pull request:

Short Version

  1. Fork the repository to your own github account
  2. Create a new branch
  3. Make your changes/improvements
  4. Write tests
  5. Run the test suite
  6. git fetch upstream master
  7. git rebase upstream master
  8. git push origin YOUR_BRANCH
  9. Open a pull request

If you have more than 5 commits, please try and squash them into less than or equal to 5. This helps to keep the repository and history clear and free of clutter.

Clone this wiki locally