docs: update md files
This commit is contained in:
Łukasz Holeczek
@@ -0,0 +1,46 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
@@ -0,0 +1,83 @@
|
||||
## Git Commit Message Convention
|
||||
|
||||
> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/convention.md).
|
||||
|
||||
#### Examples
|
||||
|
||||
Appears under "Features" header, `compiler` subheader:
|
||||
|
||||
```
|
||||
feat(compiler): add 'comments' option
|
||||
```
|
||||
|
||||
Appears under "Bug Fixes" header, `sidebar` subheader, with a link to issue #28:
|
||||
|
||||
```
|
||||
fix(sidebar): handle events on blur
|
||||
|
||||
close #28
|
||||
```
|
||||
|
||||
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
|
||||
|
||||
```
|
||||
perf(core): improve vdom diffing by removing 'foo' option
|
||||
|
||||
BREAKING CHANGE: The 'foo' option has been removed.
|
||||
```
|
||||
|
||||
The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
|
||||
|
||||
```
|
||||
revert: feat(compiler): add 'comments' option
|
||||
|
||||
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
|
||||
```
|
||||
|
||||
### Full Message Format
|
||||
|
||||
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
|
||||
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
<BLANK LINE>
|
||||
<body>
|
||||
<BLANK LINE>
|
||||
<footer>
|
||||
```
|
||||
|
||||
The **header** is mandatory and the **scope** of the header is optional.
|
||||
|
||||
### Revert
|
||||
|
||||
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
|
||||
|
||||
### Type
|
||||
|
||||
If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
|
||||
|
||||
Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
|
||||
|
||||
### Scope
|
||||
|
||||
The scope could be anything specifying place of the commit change. For example `core`, `compiler`, `ssr`, `v-model`, `transition` etc...
|
||||
|
||||
### Subject
|
||||
|
||||
The subject contains succinct description of the change:
|
||||
|
||||
* use the imperative, present tense: "change" not "changed" nor "changes"
|
||||
* don't capitalize first letter
|
||||
* no dot (.) at the end
|
||||
|
||||
### Body
|
||||
|
||||
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
|
||||
The body should include the motivation for the change and contrast this with previous behavior.
|
||||
|
||||
### Footer
|
||||
|
||||
The footer should contain any information about **Breaking Changes** and is also the place to
|
||||
reference GitHub issues that this commit **Closes**.
|
||||
|
||||
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
|
||||
+40
-38
@@ -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
|
||||
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
custom: "https://coreui.io/pro/"
|
||||
@@ -1,19 +0,0 @@
|
||||
# Before opening an issue
|
||||
|
||||
- [Search for duplicate or closed issues](https://github.com/coreui/coreui-free-vue-admin-template/issues?q=is%3Aissue+is%3Aclosed)
|
||||
- Read the [contributing guidelines](https://github.com/coreui/coreui-free-vue-admin-templare/blob/v3-next/CONTRIBUTING.md)
|
||||
|
||||
When asking general "how to" questions:
|
||||
|
||||
- Please do not open an issue here
|
||||
|
||||
When reporting a bug, include:
|
||||
|
||||
- Operating system and version (Windows, Mac OS X, Android, iOS, Win10 Mobile)
|
||||
- Browser and version (Chrome, Firefox, Safari, IE, MS Edge, Opera 15+, Android Browser)
|
||||
- Reduced test cases and potential fixes using [CodePen](https://codepen.io/) or [JS Bin](https://jsbin.com/)
|
||||
|
||||
When suggesting a feature, include:
|
||||
|
||||
- As much detail as possible for what we should add and why it's important to CoreUI Vue library
|
||||
- Relevant links to prior art, screenshots, or live demos whenever possible
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Tell us about a bug you may have identified in CoreUI Free Vue Admin Template.
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
Before opening:
|
||||
|
||||
- [Search for duplicate or closed issues](https://github.com/coreui/coreui-free-vue-admin-template/issues?utf8=%E2%9C%93&q=is%3Aissue)
|
||||
- [Validate](https://html5.validator.nu/) any HTML to avoid common problems
|
||||
- Read the [contributing guidelines](https://github.com/coreui/coreui-free-vue-admin-template/blob/v4-dev/.github/CONTRIBUTING.md)
|
||||
|
||||
Bug reports must include:
|
||||
|
||||
- Operating system and version (Windows, macOS, Android, iOS)
|
||||
- Browser and version (Chrome, Firefox, Safari, Microsoft Edge, Opera, Android Browser)
|
||||
- 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/)
|
||||
@@ -0,0 +1,18 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for a new feature in CoreUI Free Vue Admin Template.
|
||||
title: ''
|
||||
labels: feature
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
Before opening:
|
||||
|
||||
- [Search for duplicate or closed issues](https://github.com/coreui/coreui-free-vue-admin-template/issues?utf8=%E2%9C%93&q=is%3Aissue)
|
||||
- Read the [contributing guidelines](https://github.com/coreui/coreui-free-vue-admin-template/blob/main/.github/CONTRIBUTING.md)
|
||||
|
||||
Feature requests must include:
|
||||
|
||||
- As much detail as possible for what we should add and why it's important to Bootstrap
|
||||
- Relevant links to prior art, screenshots, or live demos whenever possible
|
||||
@@ -0,0 +1,9 @@
|
||||
### Bug reports
|
||||
|
||||
See the [contributing guidelines](CONTRIBUTING.md) for sharing bug reports.
|
||||
|
||||
### How-to
|
||||
|
||||
For general troubleshooting or help getting started:
|
||||
|
||||
- Join [the official community](https://community.coreui.io/).
|
||||
@@ -1,49 +0,0 @@
|
||||
name: Daily project check
|
||||
|
||||
on:
|
||||
schedule:
|
||||
# build runs every weekday at 5AM UTC
|
||||
- cron: '0 5 * * 1-5'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [14.x]
|
||||
os: [ubuntu-latest, windows-latest, macOS-latest]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
- name: project check
|
||||
run: |
|
||||
npm i
|
||||
npm run clearCache
|
||||
npm run build
|
||||
npm run lint
|
||||
npm run test:unit
|
||||
env:
|
||||
CI: true
|
||||
|
||||
# e2e-chrome:
|
||||
|
||||
# runs-on: windows-latest
|
||||
|
||||
# steps:
|
||||
# - uses: actions/checkout@v1
|
||||
# - name: Use Node.js 14
|
||||
# uses: actions/setup-node@v1
|
||||
# with:
|
||||
# node-version: 14
|
||||
# - name: e2e chrome test
|
||||
# run: |
|
||||
# npm i
|
||||
# npm run test:e2e
|
||||
# env:
|
||||
# BROWSER: chrome
|
||||
@@ -1,52 +0,0 @@
|
||||
name: Project check
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [14.x]
|
||||
os: [ubuntu-latest, windows-latest, macOS-latest]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
- name: project check
|
||||
run: |
|
||||
npm i
|
||||
npm run clearCache
|
||||
npm run build
|
||||
npm run lint
|
||||
npm run test:unit
|
||||
env:
|
||||
CI: true
|
||||
|
||||
# e2e-chrome:
|
||||
|
||||
# runs-on: windows-latest
|
||||
|
||||
# steps:
|
||||
# - uses: actions/checkout@v1
|
||||
# - name: Use Node.js 14
|
||||
# uses: actions/setup-node@v1
|
||||
# with:
|
||||
# node-version: 14
|
||||
# - name: e2e chrome test
|
||||
# run: |
|
||||
# npm i
|
||||
# npm run test:e2e
|
||||
# env:
|
||||
# BROWSER: chrome
|
||||
Reference in New Issue
Block a user