Skip to content

Commit c34bf8f

Browse files
Create CONTRIBUTING.md
1 parent 5c3d2e8 commit c34bf8f

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Vue CRUD Contributing Guide
2+
Hello and thank you for interest in helping make Vue CRUD better. Please take a few moments to review the following guidelines.
3+
4+
## Reporting Issues
5+
* Try to search for your issue, it may have been answered.
6+
* See if the error is reproduceable with the latest version.
7+
* Use [issue templates](https://github.com/what-crud/vue-crud/tree/master/.github/ISSUE_TEMPLATE) for bug reports and feature requests.
8+
9+
## Pull Requests
10+
* Always work on a new branch. Making changes on your fork's `dev` or `master` branch can cause problems. (See [The beginner's guide to contributing to a GitHub project](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/))
11+
* Bug fixes should be submitted to the `master` branch.
12+
* New features and breaking changes should be submitted to the `dev` branch.
13+
* Use a descriptive title no more than 64 characters long. This will be used as the commit message when your PR is merged.
14+
* For changes and feature requests, please include an example of what you are trying to solve and an example of the markup. It is preferred that you create an issue first however, as that will allow the team to review your proposal before you start.
15+
* Please reference the issue # that the PR resolves, something like `Fixes #1234` or `Resolves #6458` (See [closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))

0 commit comments

Comments
 (0)