Skip to content

Latest commit

 

History

History
99 lines (63 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

99 lines (63 loc) · 2.9 KB
Raw

Contributing

So far this is a one-man project, and new contributions will be greatly appreciated. You're welcome to submit pull requests, propose features and discuss issues. When in doubt, ask a question in the Participate App Google Group.

Fork the Project

Fork the project on Github and check out your copy.

git clone https://github.com/contributor/participate-api.git
cd participate-api
git remote add upstream https://github.com/oliverbarnes/participate-api.git

Create a Topic Branch

Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.

git checkout master
git pull upstream master
git checkout -b my-feature-branch

Write Tests

Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to spec/.

I also appreciate pull requests that highlight or reproduce a problem, even without a fix.

Write Code

Implement your feature or bug fix. Please be sure to submit clean, well refactored code.

Update Changelog

Add a line to CHANGELOG. Make it look like every other line, including your name and link to your Github account.

Commit Changes

Make sure git knows your name and email address:

git config --global user.name "Your Name"
git config --global user.email "contributor@example.com"

Writing good commit logs is important. A commit log should describe what changed and why.

git add ...
git commit

Push

git push origin my-feature-branch

Make a Pull Request

Go to https://github.com/contributor/participate-api and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed daily on weekdays.

If you're new to Pull Requests, check out the Github docs

Rebase

If you've been working on a change for a while, rebase with upstream/master.

git fetch upstream
git rebase upstream/master
git push origin my-feature-branch -f

Update CHANGELOG Again

Update the CHANGELOG with the pull request number. A typical entry looks as follows (fake entry).

* [#123](https://github.com/oliverbarnes/participate-api/pull/123): Add vote notifications - [@contributor](https://github.com/contributor).

Amend your previous commit and force push the changes.

git commit --amend
git push origin my-feature-branch -f

Be Patient

It's likely that your change will not be merged and that I will ask you to do more, or fix seemingly benign problems. Hang on there!

Thank You

Again, any contribution small or big is greatly appreciated. Thank you.