Contributions are much appreciated!
You're welcome to submit pull requests, propose features and post bugs on Github issues, and ask questions on our Slack channel (ping me for an invite by email or on twitter).
Here are the steps for contributing code:
Fork the project on Github and check out your copy.
git clone https://github.com/contributor/web-client.git
cd participate
git remote add upstream https://github.com/participateapp/web-client.git
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
If the feature or bug is related to an existing github issue, please prefix the branch with the issue number:
git checkout -b 75-fix-some-bug
Implement your feature or bug fix. Please be sure to submit clean, well refactored code, as self-explanatory as possible.
Document any new user-visible behavior in the README.
Sometimes even with great code it's helpful to add some comments, specially with examples of usage. Add these inline.
Make sure git knows your name and email address:
git config --global user.name "Your Name"
git config --global user.email "[email protected]"
Writing good commit logs is important. A commit log should describe what changed and why.
git add ...
git commit
If you've been working on a change for a while, rebase with upstream/master.
git push origin my-feature-branch
Go to https://github.com/contributor/web-client 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
git fetch upstream
git rebase upstream/master
git push origin my-feature-branch -f
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 in there!