|
| 1 | +# Contributing to CoreUI Free React Admin Template |
| 2 | + |
| 3 | +Looking to contribute something to CoreUI Free React Admin Template? **Here's how you can help.** |
| 4 | + |
| 5 | +Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved. |
| 6 | + |
| 7 | +Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features. |
| 8 | + |
| 9 | +## Using the issue tracker |
| 10 | + |
| 11 | +The [issue tracker](https://github.com/coreui/coreui-free-react-admin-template/issues) is the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests) and [submitting pull requests](#pull-requests), but please respect the following restrictions: |
| 12 | + |
| 13 | +* Please **do not** use the issue tracker for personal support requests. |
| 14 | + |
| 15 | +* Please **do not** post comments consisting solely of "+1" or ":thumbsup:". |
| 16 | + Use [GitHub's "reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) |
| 17 | + instead. |
| 18 | + |
| 19 | +* Please **do not** open issues or pull requests regarding the code in [`@coreui/coreui`](https://github.com/coreui/coreui-react) (open them in their respective repositories). |
| 20 | + |
| 21 | +## Bug reports |
| 22 | + |
| 23 | +A bug is a _demonstrable problem_ that is caused by the code in the repository. |
| 24 | +Good bug reports are extremely helpful, so thanks! |
| 25 | + |
| 26 | +Guidelines for bug reports: |
| 27 | + |
| 28 | +0. **Validate and lint your code** — to ensure your problem isn't caused by a simple error in your own code. |
| 29 | + |
| 30 | +1. **Use the GitHub issue search** — check if the issue has already been reported. |
| 31 | + |
| 32 | +2. **Check if the issue has been fixed** — try to reproduce it using the latest `master` or development branch in the repository. |
| 33 | + |
| 34 | +3. **Isolate the problem** — ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live example. [This JS Bin](http://jsbin.com/lefey/1/edit?html,output) is a helpful template. |
| 35 | + |
| 36 | + |
| 37 | +A good bug report shouldn't leave others needing to chase you up for more |
| 38 | +information. Please try to be as detailed as possible in your report. What is |
| 39 | +your environment? What steps will reproduce the issue? What browser(s) and OS |
| 40 | +experience the problem? Do other browsers show the bug differently? What |
| 41 | +would you expect to be the outcome? All these details will help people to fix |
| 42 | +any potential bugs. |
| 43 | + |
| 44 | +Example: |
| 45 | + |
| 46 | +> Short and descriptive example bug report title |
| 47 | +> |
| 48 | +> A summary of the issue and the browser/OS environment in which it occurs. If |
| 49 | +> suitable, include the steps required to reproduce the bug. |
| 50 | +> |
| 51 | +> 1. This is the first step |
| 52 | +> 2. This is the second step |
| 53 | +> 3. Further steps, etc. |
| 54 | +> |
| 55 | +> `<url>` - a link to the reduced test case |
| 56 | +> |
| 57 | +> Any other information you want to share that is relevant to the issue being |
| 58 | +> reported. This might include the lines of code that you have identified as |
| 59 | +> causing the bug, and potential solutions (and your opinions on their |
| 60 | +> merits). |
| 61 | +
|
| 62 | +## Feature requests |
| 63 | + |
| 64 | +Feature requests are welcome. Before opening a feature request, please take a moment to find out whether your idea |
| 65 | +fits with the scope and aims of the project. It's up to *you* to make a strong |
| 66 | +case to convince the project's developers of the merits of this feature. Please |
| 67 | +provide as much detail and context as possible. |
| 68 | + |
| 69 | + |
| 70 | +## Pull requests |
| 71 | + |
| 72 | +Good pull requests—patches, improvements, new features—are a fantastic |
| 73 | +help. They should remain focused in scope and avoid containing unrelated |
| 74 | +commits. |
| 75 | + |
| 76 | +**Please ask first** before embarking on any significant pull request (e.g. |
| 77 | +implementing features, refactoring code, porting to a different language), |
| 78 | +otherwise you risk spending a lot of time working on something that the |
| 79 | +project's developers might not want to merge into the project. |
| 80 | + |
| 81 | +Adhering to the following process is the best way to get your work |
| 82 | +included in the project: |
| 83 | + |
| 84 | +1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork, |
| 85 | + and configure the remotes: |
| 86 | + |
| 87 | + ```bash |
| 88 | + # Clone your fork of the repo into the current directory |
| 89 | + git clone https://github.com/<your-username>/free-react-admin-template.git |
| 90 | + # Navigate to the newly cloned directory |
| 91 | + cd free-react-admin-template |
| 92 | + # Assign the original repo to a remote called "upstream" |
| 93 | + git remote add upstream https://github.com/coreui/coreui-free-react-admin-template.git |
| 94 | + ``` |
| 95 | + |
| 96 | +2. If you cloned a while ago, get the latest changes from upstream: |
| 97 | + |
| 98 | + ```bash |
| 99 | + git checkout master |
| 100 | + git pull upstream master |
| 101 | + ``` |
| 102 | + |
| 103 | +3. Create a new topic branch (off the main project development branch) to |
| 104 | + contain your feature, change, or fix: |
| 105 | + |
| 106 | + ```bash |
| 107 | + git checkout -b <topic-branch-name> |
| 108 | + ``` |
| 109 | + |
| 110 | +4. Commit your changes in logical chunks. Please adhere to these [git commit |
| 111 | + message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) |
| 112 | + or your code is unlikely to be merged into the main project. Use Git's |
| 113 | + [interactive rebase](https://help.github.com/articles/interactive-rebase) |
| 114 | + feature to tidy up your commits before making them public. |
| 115 | + |
| 116 | +5. Locally merge (or rebase) the upstream development branch into your topic branch: |
| 117 | + |
| 118 | + ```bash |
| 119 | + git pull [--rebase] upstream master |
| 120 | + ``` |
| 121 | + |
| 122 | +6. Push your topic branch up to your fork: |
| 123 | + |
| 124 | + ```bash |
| 125 | + git push origin <topic-branch-name> |
| 126 | + ``` |
| 127 | + |
| 128 | +7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description against the `master` branch. |
| 129 | + |
| 130 | +**IMPORTANT**: By submitting a patch, you agree to allow the project owners to license your work under the terms of the [MIT License](LICENSE). |
| 131 | + |
| 132 | +### Semantic Git commit messages |
| 133 | + |
| 134 | +Inspired by Sparkbox's awesome article on [semantic commit messages](http://seesparkbox.com/foundry/semantic_commit_messages). Please use following commit message format. |
| 135 | + |
| 136 | +* chore (updating npm tasks etc; no production code change) -> ```git test -m 'chore: commit-message-here'``` |
| 137 | +* docs (changes to documentation) -> ```git commit -m 'docs: commit-message-here'``` |
| 138 | +* feat (new feature) -> ```git commit -m 'feat: commit-message-here'``` |
| 139 | +* fix (bug fix) -> ```git commit -m 'fix: commit-message-here'``` |
| 140 | +* refactor (refactoring production code) -> ```git commit -m 'refactor: commit-message-here'``` |
| 141 | +* style (formatting, missing semi colons, etc; no code change) -> ```git commit -m 'style: commit-message-here'``` |
| 142 | +* test (adding missing tests, refactoring tests; no production code change) -> ```git test -m 'refactor: commit-message-here'``` |
| 143 | + |
| 144 | + |
| 145 | +## Code guidelines |
| 146 | + |
| 147 | +### HTML |
| 148 | + |
| 149 | +[Adhere to the Code Guide.](http://codeguide.co/#html) |
| 150 | + |
| 151 | +- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags). |
| 152 | +- 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://`. |
| 153 | +- Use [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes in documentation examples to promote accessibility. |
| 154 | + |
| 155 | +### CSS |
| 156 | + |
| 157 | +[Adhere to the Code Guide.](http://codeguide.co/#css) |
| 158 | + |
| 159 | +- When feasible, default color palettes should comply with [WCAG color contrast guidelines](http://www.w3.org/TR/WCAG20/#visual-audio-contrast). |
| 160 | +- 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. |
| 161 | + |
| 162 | +### JS |
| 163 | + |
| 164 | +- No semicolons (in client-side JS) |
| 165 | +- 2 spaces (no tabs) |
| 166 | +- strict mode |
| 167 | +- "Attractive" |
| 168 | +- Don't use [jQuery event alias convenience methods](https://github.com/jquery/jquery/blob/master/src/event/alias.js) (such as `$().focus()`). Instead, use [`$().trigger(eventType, ...)`](http://api.jquery.com/trigger/) or [`$().on(eventType, ...)`](http://api.jquery.com/on/), depending on whether you're firing an event or listening for an event. (For example, `$().trigger('focus')` or `$().on('focus', function (event) { /* handle focus event */ })`) We do this to be compatible with custom builds of jQuery where the event aliases module has been excluded. |
| 169 | + |
| 170 | +## License |
| 171 | + |
| 172 | +By contributing your code, you agree to license your contribution under the [MIT License](LICENSE). |
0 commit comments