Skip to content

Commit a6ca9ef

Browse files
committed
docs: update contributing guide
1 parent 2c8c265 commit a6ca9ef

File tree

1 file changed

+6
-41
lines changed

1 file changed

+6
-41
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -4,48 +4,19 @@ Looking to contribute something to CoreUI Free Bootstrap Admin Template? **Here'
44

55
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
66

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
8-
patches and features.
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.
98

109
## Using the issue tracker
1110

12-
The [issue tracker](https://github.com/coreui/coreui-free-bootstrap-admin-template/issues) is
13-
the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests)
14-
and [submitting pull requests](#pull-requests), but please respect the following
15-
restrictions:
11+
The [issue tracker](https://github.com/coreui/coreui-free-bootstrap-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:
1612

1713
* Please **do not** use the issue tracker for personal support requests.
1814

19-
<!-- Stack Overflow ([`twitter-bootstrap-3`](https://stackoverflow.com/questions/tagged/twitter-bootstrap-3) tag), [Slack](https://bootstrap-slack.herokuapp.com/) or [IRC](README.md#community) are better places to get help. -->
20-
2115
* Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
2216
Use [GitHub's "reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
2317
instead.
2418

25-
* Please **do not** open issues or pull requests regarding the code in [`@coreui/static`](https://github.com/coreui/static) and [`@coreui/styles`](https://github.com/coreui/styles) (open them in their respective repositories).
26-
27-
<!-- * Please **do not** open issues regarding the official themes offered on <http://themes.getbootstrap.com/>.
28-
Instead, please email any questions or feedback regarding those themes to `themes AT getbootstrap DOT com`. -->
29-
30-
31-
## Issues and labels
32-
33-
Our bug tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:
34-
35-
- `browser bug` - Issues that are reported to us, but actually are the result of a browser-specific bug. These are diagnosed with reduced test cases and result in an issue opened on that browser's own bug tracker.
36-
- `confirmed` - Issues that have been confirmed with a reduced test case and identify a bug in Bootstrap.
37-
- `css` - Issues stemming from our compiled CSS or source Less/Sass files.
38-
- `customizer` - Issues with our web-based Customizer.
39-
- `docs` - Issues for improving or updating our documentation.
40-
- `examples` - Issues involving the example templates included in our docs.
41-
- `feature` - Issues asking for a new feature to be added, or an existing one to be extended or modified. New features require a minor version bump (e.g., `v3.0.0` to `v3.1.0`).
42-
- `grunt` - Issues with our included JavaScript-based Gruntfile, which is used to run all our tests, concatenate and compile source files, and more.
43-
- `help wanted` - Issues we need or would love help from the community to resolve.
44-
- `js` - Issues stemming from our compiled or source JavaScript files.
45-
- `meta` - Issues with the project itself or our GitHub repository.
46-
47-
For a complete look at our labels, see the [project labels page](https://github.com/twbs/bootstrap/labels).
48-
19+
* Please **do not** open issues or pull requests regarding the code in [`@coreui/coreui`](https://github.com/coreui/coreui) (open them in their respective repositories).
4920

5021
## Bug reports
5122

@@ -154,14 +125,9 @@ included in the project:
154125
git push origin <topic-branch-name>
155126
```
156127

157-
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
158-
with a clear title and description against the `master` branch.
128+
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description against the `master` branch.
159129

160-
**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
161-
license your work under the terms of the [MIT License](LICENSE) (if it
162-
includes code changes) and under the terms of the
163-
[Creative Commons Attribution 3.0 Unported License](docs/LICENSE)
164-
(if it includes documentation changes).
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).
165131

166132
### Semantic Git commit messages
167133

@@ -203,7 +169,6 @@ Inspired by Sparkbox's awesome article on [semantic commit messages](http://sees
203169

204170
## License
205171

206-
By contributing your code, you agree to license your contribution under the [MIT License](LICENSE).
207-
By contributing to the documentation, you agree to license your contribution under the [Creative Commons Attribution 3.0 Unported License](docs/LICENSE).
172+
By contributing your code, you agree to license your contribution under the [MIT License](LICENSE). By contributing to the documentation, you agree to license your contribution under the [Creative Commons Attribution 3.0 Unported License](docs/LICENSE).
208173

209174
Prior to v3.1.0, Bootstrap's code was released under the Apache License v2.0.

0 commit comments

Comments
 (0)