sean/manja_ui_dev
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: update md files

Browse Source
This commit is contained in:
Łukasz Holeczek
2021-08-29 15:55:06 +02:00
parent 374ea047ba
commit 1b7a092079
10 changed files with 219 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/CONTRIBUTING.md
+40 -38
View File
@@ -1,30 +1,25 @@
# Contributing to CoreUI Vue Admin Template
# Contributing to CoreUI
Looking to contribute something? **Here's how you can help.**
Looking to contribute something to CoreUI? **Here's how you can help.**
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
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.
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.
## Using the issue tracker
The [issue tracker](https://github.com/coreui/coreui-free-vue-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:
The [issue tracker](https://github.com/coreui/coreui-free-vue-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:
- Please **do not** use the issue tracker for personal support requests.
* Please **do not** use the issue tracker for personal support requests.
- Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
Use [GitHub's "reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
* Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
Use [GitHub's "vueions" feature](https://github.com/blog/2119-add-vueions-to-pull-requests-issues-and-comments)
instead.
- Please **do not** open issues or pull requests regarding the code in:
- [`@coreui/vue`](https://github.com/coreui/coreui-vue)
- [`@coreui/coreui`](https://github.com/coreui/coreui)
- [`@coreui/coreui-icons-vue`](https://github.com/coreui/coreui-icons-vue)
- [`@coreui/coreui-vue-chartjs`](https://github.com/coreui/coreui-vue-chartjs)
Open them in their respective repositories.
## Bug reports
A bug is a _demonstrable problem_ that is caused by the code in the repository.
@@ -36,10 +31,11 @@ Guidelines for bug reports:
1. **Use the GitHub issue search** — check if the issue has already been reported.
2. **Check if the issue has been fixed** — try to reproduce it using the latest `master` or `dev` branch in the repository.
2. **Check if the issue has been fixed** — try to reproduce it using the latest `master` or development branch in the repository.
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.
A good bug report shouldn't leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report. What is
your environment? What steps will reproduce the issue? What browser(s) and OS
@@ -67,10 +63,12 @@ Example:
## Feature requests
Feature requests are welcome. Before opening a feature request, please take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to *you* to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.
Feature requests are welcome. Before opening a feature request, please take a
moment to find out whether your idea fits with the scope and aims of the
project. It's up to *you* to make a strong case to convince the project's
developers of the merits of this feature. Please provide as much detail
and context as possible.
## Pull requests
@@ -91,21 +89,21 @@ included in the project:
```bash
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/coreui-free-vue-admin-template.git
git clone https://github.com/<your-username>/coreui-vue.git
# Navigate to the newly cloned directory
cd coreui-free-vue-admin-template
cd coreui
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/coreui/coreui-free-vue-admin-template.git
git remote add upstream https://github.com/coreui/coreui-vue.git
```
2. If you cloned a while ago, get the latest changes from upstream:
```bash
git checkout dev
git pull upstream dev
git checkout master
git pull upstream master
```
3. Create a new topic branch (off the development branch "dev") to
3. Create a new topic branch (off the main project development branch) to
contain your feature, change, or fix:
```bash
@@ -121,7 +119,7 @@ included in the project:
5. Locally merge (or rebase) the upstream development branch into your topic branch:
```bash
git pull [--rebase] upstream dev
git pull [--rebase] upstream master
```
6. Push your topic branch up to your fork:
@@ -130,21 +128,25 @@ included in the project:
git push origin <topic-branch-name>
```
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description into the `dev` branch.
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description against the `master` branch.
**IMPORTANT**: By submitting a patch, you agree to allow the project owners to license your work under the terms of the [MIT License](LICENSE).
**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
license your work under the terms of the [MIT License](LICENSE).
### Semantic Git commit messages
Inspired by Sparkbox's awesome article on [semantic commit messages](http://seesparkbox.com/foundry/semantic_commit_messages). Please use following commit message format.
Inspired by Sparkbox's awesome article on
[semantic commit messages](http://seesparkbox.com/foundry/semantic_commit_messages).
Please use following commit message format.
- chore (updating npm tasks etc; no production code change) -> ```git test -m 'chore: commit-message-here'```
- docs (changes to documentation) -> ```git commit -m 'docs: commit-message-here'```
- feat (new feature) -> ```git commit -m 'feat: commit-message-here'```
- fix (bug fix) -> ```git commit -m 'fix: commit-message-here'```
- refactor (refactoring production code) -> ```git commit -m 'refactor: commit-message-here'```
- style (formatting, missing semi colons, etc; no code change) -> ```git commit -m 'style: commit-message-here'```
- test (adding missing tests, refactoring tests; no production code change) -> ```git commit -m 'test: commit-message-here'```
* chore (updating npm tasks etc; no production code change) -> ```git test -m 'chore: commit-message-here'```
* docs (changes to documentation) -> ```git commit -m 'docs: commit-message-here'```
* feat (new feature) -> ```git commit -m 'feat: commit-message-here'```
* fix (bug fix) -> ```git commit -m 'fix: commit-message-here'```
* refactor (refactoring production code) -> ```git commit -m 'refactor: commit-message-here'```
* style (formatting, missing semi colons, etc; no code change) -> ```git commit -m 'style: commit-message-here'```
* test (adding missing tests, refactoring tests; no production code change) -> ```git test -m 'refactor: commit-message-here'```
## Code guidelines