|
1 | | -# Contributing |
2 | | - |
3 | | -We love pull requests and would be very grateful if you'd help us abolish suffering with data! |
4 | | - |
5 | | -[ ] [Fork](https://help.github.com/articles/fork-a-repo/) a copy of the repo to your own Github account. |
6 | | - |
7 | | -[ ] [Clone](https://help.github.com/articles/cloning-a-repository/) your forked version of the repo locally. |
8 | | -(Ideally, use a powerful GUI git client like [SourceTree](https://www.sourcetreeapp.com/). The command line is for barbarians.) |
9 | | - |
10 | | -If you must use the command line, you can use these: |
11 | | - |
12 | | -``` |
13 | | -git clone [email protected]:your-username/quantimodo-android-chrome-ios-web-app.git |
14 | | -``` |
15 | | - |
16 | | -Set up a branch for your feature or bugfix with a link to the original repo: |
17 | | - |
18 | | -``` |
19 | | -git checkout -b my-awesome-new-feature |
20 | | -git push --set-upstream origin my-awesome-new-feature |
21 | | -git remote add upstream https://github.com/QuantiModo/quantimodo-android-chrome-ios-web-app.git |
22 | | -``` |
23 | | - |
24 | | -Commit changes: |
25 | | - |
26 | | -``` |
27 | | -git commit -m "Cool stuff" |
28 | | -``` |
29 | | - |
30 | | -Make sure your branch is up to date with the original repo: |
31 | | - |
32 | | -``` |
33 | | -git fetch upstream |
34 | | -git merge upstream/master |
35 | | -``` |
36 | | - |
37 | | -Review your changes and any possible conflicts and push to your fork: |
38 | | - |
39 | | -``` |
40 | | -git push origin |
41 | | -``` |
42 | | - |
43 | | -[Submit a pull request on Github.com](https://help.github.com/articles/creating-a-pull-request/). |
44 | | - |
45 | | -At this point you're waiting on me. I do my best to keep on top of all the pull requests. |
46 | | -I may suggest some changes, improvements or alternatives. |
47 | | - |
48 | | -Some things that will increase the chance that your pull request is accepted: |
49 | | - |
50 | | -- Write tests. |
51 | | -- Write a [good commit message](http://chris.beams.io/posts/git-commit/). |
52 | | -- Make sure the PR merges cleanly with the latest master. |
53 | | -- Describe your feature/bugfix and why it's needed/important in the pull request description. |
54 | | - |
55 | | -## Editor Config |
56 | | - |
57 | | -The project uses [.editorconfig](http://editorconfig.org/) to define the coding |
58 | | -style of each file. We recommend that you install the Editor Config extension |
59 | | -for your preferred IDE. Consistency is key. |
60 | | - |
61 | | -## JSHint |
62 | | - |
63 | | -The project uses [.jshint](http://jshint.com/docs) to define the JavaScript |
64 | | -coding conventions. Most editors now have a JSHint add-on to provide on-save |
65 | | -or on-edit linting. |
66 | | - |
67 | | -### Install JSHint for vim |
68 | | - |
69 | | -1. Install [jshint](https://www.npmjs.com/package/jshint). |
70 | | -1. Install [jshint.vim](https://github.com/wookiehangover/jshint.vim). |
71 | | - |
72 | | -### Install JSHint for Sublime |
73 | | - |
74 | | -1. Install [Package Control](https://packagecontrol.io/installation) |
75 | | -1. Restart Sublime |
76 | | -1. Type `CMD+SHIFT+P` |
77 | | -1. Type _Install Package_ |
78 | | -1. Type _JSHint Gutter_ |
79 | | -1. Sublime -> Preferences -> Package Settings -> JSHint Gutter |
80 | | -1. Set `lint_on_load` and `lint_on_save` to `true` |
81 | | - |
82 | | -Tips |
83 | | - |
84 | | -- I recommend using [SourceTree and the Gitflow model] (https://github.com/GSoft-SharePoint/Dynamite/wiki/Getting-started-with-SourceTree,-Git-and-git-flow) for development. |
| 1 | +# Contributing |
| 2 | + |
| 3 | +We love pull requests and would be very grateful if you'd help us abolish suffering with data! |
| 4 | + |
| 5 | +[ ] [Fork](https://help.github.com/articles/fork-a-repo/) a copy of the repo to your own Github account. |
| 6 | + |
| 7 | +[ ] [Clone](https://help.github.com/articles/cloning-a-repository/) your forked version of the repo locally. |
| 8 | +(Ideally, use a powerful GUI git client like [SourceTree](https://www.sourcetreeapp.com/). The command line is for |
| 9 | +barbarians.) |
| 10 | + |
| 11 | +If you must use the command line, you can use these: |
| 12 | + |
| 13 | +``` |
| 14 | +git clone [email protected]:your-username/quantimodo-android-chrome-ios-web-app.git |
| 15 | +``` |
| 16 | + |
| 17 | +Set up a branch for your feature or bugfix with a link to the original repo: |
| 18 | + |
| 19 | +``` |
| 20 | +git checkout -b my-awesome-new-feature |
| 21 | +git push --set-upstream origin my-awesome-new-feature |
| 22 | +git remote add upstream https://github.com/QuantiModo/quantimodo-android-chrome-ios-web-app.git |
| 23 | +``` |
| 24 | + |
| 25 | +Commit changes: |
| 26 | + |
| 27 | +``` |
| 28 | +git commit -m "Cool stuff" |
| 29 | +``` |
| 30 | + |
| 31 | +Make sure your branch is up to date with the original repo: |
| 32 | + |
| 33 | +``` |
| 34 | +git fetch upstream |
| 35 | +git merge upstream/master |
| 36 | +``` |
| 37 | + |
| 38 | +Review your changes and any possible conflicts and push to your fork: |
| 39 | + |
| 40 | +``` |
| 41 | +git push origin |
| 42 | +``` |
| 43 | + |
| 44 | +[Submit a pull request on Github.com](https://help.github.com/articles/creating-a-pull-request/). |
| 45 | + |
| 46 | +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, |
| 47 | +improvements or alternatives. |
| 48 | + |
| 49 | +Some things that will increase the chance that your pull request is accepted: |
| 50 | + |
| 51 | +- Write tests. |
| 52 | +- Write a [good commit message](http://chris.beams.io/posts/git-commit/). |
| 53 | +- Make sure the PR merges cleanly with the latest master. |
| 54 | +- Describe your feature/bugfix and why it's needed/important in the pull request description. |
| 55 | + |
| 56 | +## Editor Config |
| 57 | + |
| 58 | +The project uses [.editorconfig](http://editorconfig.org/) to define the coding |
| 59 | +style of each file. We recommend that you install the Editor Config extension |
| 60 | +for your preferred IDE. Consistency is key. |
| 61 | + |
| 62 | +## JSHint |
| 63 | + |
| 64 | +The project uses [.jshint](http://jshint.com/docs) to define the JavaScript |
| 65 | +coding conventions. Most editors now have a JSHint add-on to provide on-save |
| 66 | +or on-edit linting. |
| 67 | + |
| 68 | +### Install JSHint for vim |
| 69 | + |
| 70 | +1. Install [jshint](https://www.npmjs.com/package/jshint). |
| 71 | +1. Install [jshint.vim](https://github.com/wookiehangover/jshint.vim). |
| 72 | + |
| 73 | +### Install JSHint for Sublime |
| 74 | + |
| 75 | +1. Install [Package Control](https://packagecontrol.io/installation) |
| 76 | +1. Restart Sublime |
| 77 | +1. Type `CMD+SHIFT+P` |
| 78 | +1. Type _Install Package_ |
| 79 | +1. Type _JSHint Gutter_ |
| 80 | +1. Sublime -> Preferences -> Package Settings -> JSHint Gutter |
| 81 | +1. Set `lint_on_load` and `lint_on_save` to `true` |
| 82 | + |
| 83 | +### Tips |
| 84 | + |
| 85 | +- I recommend using [SourceTree and the Gitflow model] (https://github.com/GSoft-SharePoint/Dynamite/wiki/Getting-started-with-SourceTree,-Git-and-git-flow) for development. |
| 86 | + |
0 commit comments