- Submit a Github issue for your issue, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug.
-
You can find our backlog at https://huboard.com/womenrising/womenrising
- These items are tied directly to Github Issues, the ones in the "Ready" column (or have a ready label in the issues list) are ready to work on.
-
Fork, then clone the repo:
git clone [email protected]:your-username/womenrising.git -
Create a topic branch from where you want to base your work.
- This is usually the master branch.
- Name your branch appropriately: [github-issue-#]-short-description
- Example
21-refactor-peer-group-specs
-
Write tests and make your change. Make the tests pass:
rspec spec/ -
Make commits of logical units.
- Check for unnecessary whitespace with
git diff --checkbefore committing. - Make sure your commit messages are in the [proper format.] commit
- Check for unnecessary whitespace with
-
Push to your fork and submit a pull request.
-
At this point you're waiting on us. We may suggest some changes or improvements or alternatives.
-
Some things that will increase the chance that your pull request is accepted:
- Write tests. Your pull request will not be approved if there are no tests.
- Follow our style guide.
- Write a good commit message.