Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 2.78 KB

contributing.md

File metadata and controls

84 lines (57 loc) · 2.78 KB
Raw

Contributing

We love pull requests and would be very grateful if you'd help us abolish suffering with data!

[ ] Fork a copy of the repo to your own Github account.

[ ] Clone your forked version of the repo locally.
(Ideally, use a powerful GUI git client like SourceTree. The command line is for barbarians.)

If you must use the command line, you can use these:

git clone [email protected]:your-username/quantimodo-android-chrome-ios-web-app.git

Set up a branch for your feature or bugfix with a link to the original repo:

git checkout -b my-awesome-new-feature
git push --set-upstream origin my-awesome-new-feature
git remote add upstream https://github.com/QuantiModo/quantimodo-android-chrome-ios-web-app.git

Commit changes:

git commit -m "Cool stuff"

Make sure your branch is up to date with the original repo:

git fetch upstream
git merge upstream/master

Review your changes and any possible conflicts and push to your fork:

git push origin

Submit a pull request on Github.com.

At this point you're waiting on me. I do my best to keep on top of all the pull requests. I may suggest some changes, improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

  • Write tests.
  • Write a good commit message.
  • Make sure the PR merges cleanly with the latest master.
  • Describe your feature/bugfix and why it's needed/important in the pull request description.

Editor Config

The project uses .editorconfig to define the coding style of each file. We recommend that you install the Editor Config extension for your preferred IDE. Consistency is key.

JSHint

The project uses .jshint to define the JavaScript coding conventions. Most editors now have a JSHint add-on to provide on-save or on-edit linting.

Install JSHint for vim

  1. Install jshint.
  2. Install jshint.vim.

Install JSHint for Sublime

  1. Install Package Control
  2. Restart Sublime
  3. Type CMD+SHIFT+P
  4. Type Install Package
  5. Type JSHint Gutter
  6. Sublime -> Preferences -> Package Settings -> JSHint Gutter
  7. Set lint_on_load and lint_on_save to true

Tips