Skip to content

Commit e0c418f

Browse files
authored
Merge pull request #106 from ditdot-dev/contributing
Create CONTRIBUTING.md
2 parents 3d359e8 + b8e959d commit e0c418f

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# How to contribute
2+
3+
## Before creating an issue
4+
5+
* Check the [GUIDE](https://www.ditdot.hr/en/docs/vue-flow-form-guide) to see if you can find the solution to your problem by yourself.
6+
* Check the version of Vue Flow Form you are using - use the last version according to [CHANGELOG](https://github.com/ditdot-dev/vue-flow-form/blob/contributing/CHANGELOG.md).
7+
* Perform the [Issues](https://github.com/ditdot-dev/vue-flow-form/issues) search to see if the problem has already been reported.
8+
* If the issue has been reported and is still open, add a comment to it instead of opening a new issue.
9+
* If the issue has been reported and is closed, open a new issue with a link to the closed issue.
10+
* If the issue hasn't been reported, open a new issue.
11+
12+
## Creating a bug report
13+
14+
* Use a descriptive title and describe the exact steps to reproduce the problem.
15+
* Explain what kind of behavior you expected and why.
16+
* Share as much information about the problem as you can - include screenshots, GIFs, reports, etc.
17+
18+
## Suggesting an enhancement
19+
20+
* Use a descriptive title and describe the feature request/change in details
21+
* Explain why this enhancement would be useful
22+
23+
## Creating a pull request
24+
25+
* Make your changes on a feature branch. Follow the code style of the project, including indentation.
26+
* Create a new PR with the code changes
27+
* The PR description should clearly describe the problem and solution, with a reference to the appropriate issue if applicable
28+
29+

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,3 +194,7 @@ Modern browsers and IE11.
194194
## License
195195

196196
[MIT](https://github.com/ditdot-dev/vue-flow-form/blob/master/LICENSE) license.
197+
198+
## Changelog
199+
200+
Changes for each release are documented in the [release notes](https://github.com/ditdot-dev/vue-flow-form/releases).

0 commit comments

Comments
 (0)