8000 docs: update md files · devas-37/coreui-vue@a9716ed · GitHub
[go: up one dir, main page]

Skip to content

Commit a9716ed

Browse files
committed
docs: update md files
1 parent ea02d35 commit a9716ed

12 files changed

+361
-332
lines changed

.github/CONTRIBUTING.md

Lines changed: 168 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,177 @@
1-
# Contributing
1+
# Contributing to CoreUI
22

3-
## Usage
3+
Looking to contribute something to CoreUI? **Here's how you can help.**
44

5-
```bash
6-
# Install dependencies
7-
npm install
5+
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
86

9-
# Build
10-
npm run build
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.
119

12-
# Run all tests with lint/jest
13-
npm run test
10+
## Using the issue tracker
1411

15-
# Run test in watch mode
16-
npm run test:watch
12+
The [issue tracker](https://github.com/coreui/coreui-vue/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:
1716

18-
# Update test snapshot
19-
npm run test:update
17+
* Please **do not** use the issue tracker for personal support requests.
2018

21-
# Run linter
22-
npm run lint
19+
* Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
20+
Use [GitHub's "reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
21+
instead.
2322

24-
# Run linter with auto fix
25-
npm run lint:fix
26-
```
27-
## Workflow
23+
## Bug reports
2824

29-
- Create a component in the src/components folder
30-
- Add tests in the src/components/\_\_tests\_\_ folder
31-
- Register this component in src/index.js
32-
- Run lint and tests before commiting anything
33-
- Commit using [Commit Convention](./COMMIT_CONVENTION.md)
34-
- PR on github
25+
A bug is a _demonstrable problem_ that is caused by the code in the repository.
26+
Good bug reports are extremely helpful, so thanks!
27+
28+
Guidelines for bug reports:
29+
30+
0. **Validate and lint your code** — to ensure your problem isn't caused by a simple error in your own code.
31+
32+
1. **Use the GitHub issue search** — check if the issue has already been reported.
33+
34+
2. **Check if the issue has been fixed** — try to reproduce it using the latest `master` or development branch in the repository.
35+
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.
37+
38+
39+
A good bug report shouldn't leave others needing to chase you up for more
40+
information. Please try to be as detailed as possible in your report. What is
41+
your environment? What steps will reproduce the issue? What browser(s) and OS
42+
experience the problem? Do other browsers show the bug differently? What
43+
would you expect to be the outcome? All these details will help people to fix
44+
any potential bugs.
45+
46+
Example:
47+
48+
> Short and descriptive example bug report title
49+
>
50+
> A summary of the issue and the browser/OS environment in which it occurs. If
51+
> suitable, include the steps required to reproduce the bug.
52+
>
53+
> 1. This is the first step
54+
> 2. This is the second step
55+
> 3. Further steps, etc.
56+
>
57+
> `<url>` - a link to the reduced test case
58+
>
59+
> Any other information you want to share that is relevant to the issue being
60+
> reported. This might include the lines of code that you have identified as
61+
> causing the bug, and potential solutions (and your opinions on their
62+
> merits).
63+
64+
## Feature requests
65+
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.
71+
72+
73+
## Pull requests
74+
75+
Good pull requests—patches, improvements, new features—are a fantastic
76+
help. They should remain focused in scope and avoid containing unrelated
77+
commits.
78+
79+
**Please ask first** before embarking on any significant pull request (e.g.
80+
implementing features, refactoring code, porting to a different language),
81+
otherwise you risk spending a lot of time working on something that the
82+
project's developers might not want to merge into the project.
83+
84+
Adhering to the following process is the best way to get your work
85+
included in the project:
86+
87+
1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
88+
and configure the remotes:
89+
90+
```bash
91+
# Clone your fork of the repo into the current directory
92+
git clone https://github.com/<your-username>/coreui.git
93+
# Navigate to the newly cloned directory
94+
cd coreui
95+
# Assign the original repo to a remote called "upstream"
96+
git remote add upstream https://github.com/coreui/coreui.git
97+
```
98+
99+
2. If you cloned a while ago, get the latest changes from upstream:
100+
101+
```bash
102+
git checkout master
103+
git pull upstream master
104+
```
105+
106+
3. Create a new topic branch (off the main project development branch) to
107+
contain your feature, change, or fix:
108+
109+
```bash
110+
git checkout -b <topic-branch-name>
111+
```
112+
113+
4. Commit your changes in logical chunks. Please adhere to these [git commit
114+
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
115+
or your code is unlikely to be merged into the main project. Use Git's
116+
[interactive rebase](https://help.github.com/articles/interactive-rebase)
117+
feature to tidy up your commits before making them public.
118+
119+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
120+
121+
```bash
122+
git pull [--rebase] upstream master
123+
```
124+
125+
6. Push your topic branch up to your fork:
126+
127+
```bash
128+
git push origin <topic-branch-name>
129+
```
130+
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.
133+
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).
136+
137+
### Semantic Git commit messages
138+
139+
Inspired by Sparkbox's awesome article on
140+
[semantic commit messages](http://seesparkbox.com/foundry/semantic_commit_messages).
141+
Please use following commit message format.
142+
143+
* chore (updating npm tasks etc; no production code change) -> ```git test -m 'chore: commit-message-here'```
144+
* docs (changes to documentation) -> ```git commit -m 'docs: commit-message-here'```
145+
* feat (new feature) -> ```git commit -m 'feat: commit-message-here'```
146+
* fix (bug fix) -> ```git commit -m 'fix: commit-message-here'```
147+
* refactor (refactoring production code) -> ```git commit -m 'refactor: commit-message-here'```
148+
* style (formatting, missing semi colons, etc; no code change) -> ```git commit -m 'style: commit-message-here'```
149+
* test (adding missing tests, refactoring tests; no production code change) -> ```git test -m 'refactor: commit-message-here'```
150+
151+
## Code guidelines
152+
153+
### HTML
154+
155+
[Adhere to the Code Guide.](http://codeguide.co/#html)
156+
157+
- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
158+
- 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://`.
159+
- Use [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes in documentation examples to promote accessibility.
160+
161+
### CSS
162+
163+
[Adhere to the Code Guide.](http://codeguide.co/#css)
164+
165+
- When feasible, default color palettes should comply with [WCAG color contrast guidelines](http://www.w3.org/TR/WCAG20/#visual-audio-contrast).
166+
- 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) F987 for more details.
167+
168+
### JS / TS / Vue
169+
170+
- No semicolons (in client-side JS)
171+
- 2 spaces (no tabs)
172+
- strict mode
173+
- "Attractive"
174+
175+
## License
176+
177+
By contributing your code, you agree to license your contribution under the [MIT License](LICENSE).

.github/FUNDING.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These are supported funding model platforms
2+
3+
custom: "https://coreui.io/pro/"

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Bug report
3+
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-vue/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-vue/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/)

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: Ask a question
3+
url: https://community.coreui.io/
4+
about: Ask and discuss questions with other CoreUI community members
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for a new feature in CoreUI.
4+
title: ''
5+
labels: feature
6+
assignees: ''
7+
8+
---
9+
10+
Before opening:
11+
12+
- [Search for duplicate or closed issues](https://github.com/coreui/coreui-vue/issues?utf8=%E2%9C%93&q=is%3Aissue)
13+
- Read the [contributing guidelines](https://github.com/coreui/coreui-vue/blob/main/.github/CONTRIBUTING.md)
14+
15+
Feature requests must include:
16+
17+
- As much detail as possible for what we should add and why it's important to Bootstrap
18+
- Relevant links to prior art, screenshots, or live demos whenever possible

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

.github/SUPPORT.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
### Bug reports
2+
3+
See the [contributing guidelines](CONTRIBUTING.md) for sharing bug reports.
4+
5+
### How-to
6+
7+
For general troubleshooting or help getting started:
8+
9+
- Join [the official community](https://community.coreui.io/).
10+
- Ask and explore Stack Overflow with the [`coreui`](https://stackoverflow.com/questions/tagged/coreui) tag.

.github/CODE_OF_CONDUCT.md renamed to CODE_OF_CONDUCT.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
88

99
Examples of behavior that contributes to creating a positive environment include:
1010

11-
* Using welcoming and inclusive language
12-
* Being respectful of differing viewpoints and experiences
13-
* Gracefully accepting constructive criticism
14-
* Focusing on what is best for the community
15-
* Showing empathy towards other community members
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
1616

1717
Examples of unacceptable behavior by participants include:
1818

19-
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20-
* Trolling, insulting/derogatory comments, and personal or political attacks
21-
* Public or private harassment
22-
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23-
* Other conduct which could reasonably be considered inappropriate in a professional setting
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
2424

2525
## Our Responsibilities
2626

@@ -34,13 +34,10 @@ T 87F5 his Code of Conduct applies both within project spaces and in public spaces whe
3434

3535
## Enforcement
3636

37-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at . The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@coreui.io. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
3838

3939
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
4040

4141
## Attribution
4242

43-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44-
45-
[homepage]: http://contributor-covenant.org
46-
[version]: http://contributor-covenant.org/version/1/4/
43+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct/>

0 commit comments

Comments
 (0)
0