You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/CONTRIBUTING.md
+27-21
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,25 @@
1
-
# Contributing to CoreUI Free Bootstrap Admin Template
1
+
# Contributing to CoreUI
2
2
3
-
Looking to contribute something to CoreUI Free Bootstrap Admin Template? **Here's how you can help.**
3
+
Looking to contribute something to CoreUI? **Here's how you can help.**
4
4
5
5
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
6
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.
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.
8
9
9
10
## Using the issue tracker
10
11
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:
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:
12
16
13
17
* Please **do not** use the issue tracker for personal support requests.
14
18
15
19
* Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
16
20
Use [GitHub's "reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
17
21
instead.
18
22
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).
20
-
21
23
## Bug reports
22
24
23
25
A bug is a _demonstrable problem_ that is caused by the code in the repository.
@@ -29,7 +31,7 @@ Guidelines for bug reports:
29
31
30
32
1.**Use the GitHub issue search**— check if the issue has already been reported.
31
33
32
-
2.**Check if the issue has been fixed**— try to reproduce it using the latest `main` or development branch in the repository.
34
+
2.**Check if the issue has been fixed**— try to reproduce it using the latest `master` or development branch in the repository.
33
35
34
36
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
37
@@ -61,10 +63,11 @@ Example:
61
63
62
64
## Feature requests
63
65
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.
66
+
Feature requests are welcome. Before opening a feature request, please take a
67
+
moment to find out whether your idea fits with the scope and aims of the
68
+
project. It's up to *you* to make a strong case to convince the project's
69
+
developers of the merits of this feature. Please provide as much detail
70
+
and context as possible.
68
71
69
72
70
73
## Pull requests
@@ -86,18 +89,18 @@ included in the project:
86
89
87
90
```bash
88
91
# Clone your fork of the repo into the current directory
2. If you cloned a while ago, get the latest changes from upstream:
97
100
98
101
```bash
99
-
git checkout main
100
-
git pull upstream main
102
+
git checkout master
103
+
git pull upstream master
101
104
```
102
105
103
106
3. Create a new topic branch (off the main project development branch) to
@@ -116,7 +119,7 @@ included in the project:
116
119
5. Locally merge (or rebase) the upstream development branch into your topic branch:
117
120
118
121
```bash
119
-
git pull [--rebase] upstream main
122
+
git pull [--rebase] upstream master
120
123
```
121
124
122
125
6. Push your topic branch up to your fork:
@@ -125,13 +128,17 @@ included in the project:
125
128
git push origin <topic-branch-name>
126
129
```
127
130
128
-
7.[Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description against the `main` branch.
131
+
7.[Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
132
+
with a clear title and description against the `master` branch.
129
133
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).
134
+
**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
135
+
license your work under the terms of the [MIT License](LICENSE).
131
136
132
137
### Semantic Git commit messages
133
138
134
-
Inspired by Sparkbox's awesome article on [semantic commit messages](http://seesparkbox.com/foundry/semantic_commit_messages). Please use following commit message format.
about: Tell us about a bug you may have identified in CoreUI.
4
+
title: ''
5
+
labels: ''
6
+
assignees: ''
7
+
8
+
---
9
+
10
+
Before opening:
11
+
12
+
-[Search for duplicate or closed issues](https://github.com/coreui/coreui-free-bootstrap-admin-template/issues?utf8=%E2%9C%93&q=is%3Aissue)
13
+
-[Validate](https://html5.validator.nu/) any HTML to avoid common problems
14
+
- Read the [contributing guidelines](https://github.com/coreui/coreui-free-bootstrap-admin-template/blob/main/.github/CONTRIBUTING.md)
15
+
16
+
Bug reports must include:
17
+
18
+
- Operating system and version (Windows, macOS, Android, iOS)
19
+
- Browser and version (Chrome, Firefox, Safari, Microsoft Edge, Opera, Android Browser)
20
+
- A [reduced test case](https://css-tricks.com/reduced-test-cases/) or suggested fix using [CodePen](https://codepen.io/) or [JS Bin](https://jsbin.com/)
| includes convenient methods for working with the framework, including compiling code, running tests, and more.
51
51
p
52
52
| To use our build system and run template locally, you’ll need a copy of CoreUI’s source files and Node. Follow these steps and you should be ready to rock:
<pclass="text-medium-emphasis small">Add <code>.accordion-flush</code> to remove the default <code>background-color</code>, some borders, and some rounded corners to render accordions edge-to-edge with their parent container.</p>
0 commit comments