|
| 1 | +# Contributing to Kitematic |
| 2 | + |
| 3 | +Thanks for contributing and supporting the Kitematic project. |
| 4 | + |
| 5 | +Before you file a bug or pull request, please take a comment to read the |
| 6 | +following guidelines for more details on how to file a bug report or submit a |
| 7 | +pull request to help make the contribution process awesome for |
| 8 | +everyone working on this project. |
| 9 | + |
| 10 | +Following these guidelines helps to communicate that you respect the time of |
| 11 | +the developers managing and developing this open source project. In return, |
| 12 | +they should reciprocate that respect in addressing your issue or assessing |
| 13 | +patches and features. |
| 14 | + |
| 15 | + |
| 16 | +## Table of Contents |
| 17 | + |
| 18 | + - [Using the Issue Tracker](#using-the-issue-tracker) |
| 19 | + - [Bugs Reports](#bug-reports) |
| 20 | + - [Feature Requests](#feature-requests) |
| 21 | + - [Submitting Pull Requests](#submitting-pull-requests) |
| 22 | + - [Code Guidelines](#code-guidelines) |
| 23 | + - [License](#license) |
| 24 | + |
| 25 | + |
| 26 | +## Using the Issue Tracker |
| 27 | + |
| 28 | +The [Issue Tracker](https://github.com/kitematic/kitematic/issues) is |
| 29 | +the preferred channel for [Bug Reports](#bug-reports), [Features Requests](#feature-requests) |
| 30 | +and [Submitting Pull Requests](#submitting-pull-requests), but please respect the following |
| 31 | +restrictions: |
| 32 | + |
| 33 | +* Please don't use the issue tracker for personal support requests. Our |
| 34 | +[HipChat room](https://www.hipchat.com/giAT9Fqb5) is a better place to get help. |
| 35 | + |
| 36 | +## Bug Reports |
| 37 | + |
| 38 | +A bug is a _demonstrable problem_ that is caused by the code in the repository. |
| 39 | +Good bug reports are extremely helpful, so thanks! |
| 40 | + |
| 41 | +Guidelines for bug reports: |
| 42 | + |
| 43 | +1. **Use the GitHub issue search** — check if the issue has already been |
| 44 | + reported. |
| 45 | + |
| 46 | +2. **Check if the issue has been fixed** — try to reproduce it using the |
| 47 | + latest `master` or development branch in the repository. |
| 48 | + |
| 49 | +3. **More details are encouraged** — please give more details on the steps |
| 50 | + to reproduce the bug and attach a screenshot of the bug if possible. |
| 51 | + |
| 52 | +A good bug report shouldn't leave others needing to chase you up for more |
| 53 | +information. Please try to be as detailed as possible in your report. What is |
| 54 | +your environment? What steps will reproduce the issue? What browser(s) and OS |
| 55 | +experience the problem? Do other browsers show the bug differently? What |
| 56 | +would you expect to be the outcome? All these details will help people to fix |
| 57 | +any potential bugs. |
| 58 | + |
| 59 | +Example: |
| 60 | + |
| 61 | +> Short and descriptive example bug report title |
| 62 | +> |
| 63 | +> A summary of the issue and the browser/OS environment in which it occurs. If |
| 64 | +> suitable, include the steps required to reproduce the bug. |
| 65 | +> |
| 66 | +> 1. This is the first step |
| 67 | +> 2. This is the second step |
| 68 | +> 3. Further steps, etc. |
| 69 | +> |
| 70 | +> `<url>` - a link to the screen shot of the bug if possible |
| 71 | +> |
| 72 | +> Any other information you want to share that is relevant to the issue being |
| 73 | +> reported. This might include the lines of code that you have identified as |
| 74 | +> causing the bug, and potential solutions (and your opinions on their |
| 75 | +> merits). |
| 76 | +
|
| 77 | + |
| 78 | + |
| 79 | +## Feature Requests |
| 80 | + |
| 81 | +Feature requests are welcome. But take a moment to find out whether your idea |
| 82 | +fits with the scope and aims of the project. A roadmap of the project is kept |
| 83 | +on the [Kitematic Roadmap](https://trello.com/b/xea5AHRk/kitematic-roadmap) Trello board. |
| 84 | +It's up to *you* to make a strong case to convince the project's developers of |
| 85 | +the merits of this feature. Please provide as much detail and context as possible. |
| 86 | + |
| 87 | + |
| 88 | + |
| 89 | +## Submitting Pull Requests |
| 90 | + |
| 91 | +Good pull requests—patches, improvements, new features—are a fantastic |
| 92 | +help. They should remain focused in scope and avoid containing unrelated |
| 93 | +commits. |
| 94 | + |
| 95 | +**Please ask first** before embarking on any significant pull request (e.g. |
| 96 | +implementing features, refactoring code, porting to a different language), |
| 97 | +otherwise you risk spending a lot of time working on something that the |
| 98 | +project's developers might not want to merge into the project. |
| 99 | + |
| 100 | +Please adhere to the [Code Guidelines](#code-guidelines) used throughout the |
| 101 | +project (indentation, accurate comments, etc.) and any other requirements |
| 102 | +(such as test coverage). |
| 103 | + |
| 104 | +Adhering to the following process is the best way to get your work |
| 105 | +included in the project: |
| 106 | + |
| 107 | +1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, |
| 108 | + and configure the remotes: |
| 109 | + |
| 110 | + ```bash |
| 111 | + # Clone your fork of the repo into the current directory |
| 112 | + git clone https://github.com/<your-username>/kitematic.git |
| 113 | + # Navigate to the newly cloned directory |
| 114 | + cd kitematic |
| 115 | + # Assign the original repo to a remote called "upstream" |
| 116 | + git remote add upstream https://github.com/kitematic/kitematic.git |
| 117 | + ``` |
| 118 | + |
| 119 | +2. If you cloned a while ago, get the latest changes from upstream: |
| 120 | + |
| 121 | + ```bash |
| 122 | + git checkout master |
| 123 | + git pull upstream master |
| 124 | + ``` |
| 125 | + |
| 126 | +3. Create a new topic branch (off the main project development branch) to |
| 127 | + contain your feature, change, or fix: |
| 128 | + |
| 129 | + ```bash |
| 130 | + git checkout -b <topic-branch-name> |
| 131 | + ``` |
| 132 | + |
| 133 | +4. Commit your changes in logical chunks. Please adhere to these [git commit |
| 134 | + message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) |
| 135 | + or your code is unlikely be merged into the main project. Use Git's |
| 136 | + [interactive rebase](https://help.github.com/articles/interactive-rebase) |
| 137 | + feature to tidy up your commits before making them public. |
| 138 | + |
| 139 | +5. Locally merge (or rebase) the upstream development branch into your topic branch: |
| 140 | + |
| 141 | + ```bash |
| 142 | + git pull [--rebase] upstream master |
| 143 | + ``` |
| 144 | + |
| 145 | +6. Push your topic branch up to your fork: |
| 146 | + |
| 147 | + ```bash |
| 148 | + git push origin <topic-branch-name> |
| 149 | + ``` |
| 150 | + |
| 151 | +7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) |
| 152 | + with a clear title and description against the `master` branch. |
| 153 | + |
| 154 | + |
| 155 | + |
| 156 | +## Code Guidelines |
| 157 | + |
| 158 | +### Javascript |
| 159 | + |
| 160 | +- Semicolons (in client-side JS) |
| 161 | +- 2 spaces (no tabs) |
| 162 | +- strict mode |
| 163 | +- "Attractive" |
| 164 | + |
| 165 | +#### Checking Javascript code standards with JSHint |
| 166 | + |
| 167 | +Run `sh jshint.sh` before committing to ensure your changes follow our coding |
| 168 | +standards. Add any exceptions to global variables at the bottom of the |
| 169 | +*.jshintrc* file. |
| 170 | + |
| 171 | +### HTML |
| 172 | + |
| 173 | +[Adhere to the Code Guide.](http://codeguide.co/#html) |
| 174 | + |
| 175 | +- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags). |
| 176 | +- Use CDNs and HTTPS for third-party JS when possible. We don't use protocol-relative URLs in this case because they break when viewing the page locally via `file://`. |
| 177 | +- Use [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes in documentation examples to promote accessibility. |
| 178 | + |
| 179 | +### CSS/LESS |
| 180 | + |
| 181 | +[Adhere to the Code Guide.](http://codeguide.co/#css) |
| 182 | + |
| 183 | +- When feasible, default color palettes should comply with [WCAG color contrast guidelines](http://www.w3.org/TR/WCAG20/#visual-audio-contrast). |
| 184 | +- Except in rare cases, don't remove default `:focus` styles (via e.g. `outline: none;`) without providing alternative styles. See [this A11Y Project post](http://a11yproject.com/posts/never-remove-css-outlines/) for more details. |
| 185 | + |
| 186 | + |
| 187 | + |
| 188 | +## License |
| 189 | + |
| 190 | +By contributing your code, you agree to license your contribution under the [AGPL license](https://github.com/kitematic/kitematic/blob/master/LICENSE). |
0 commit comments