File tree 2 files changed +47
-4
lines changed
2 files changed +47
-4
lines changed Original file line number Diff line number Diff line change
1
+ # Contributions
2
+
3
+ 🎉 Thanks for considering contributing to this project! 🎉
4
+
5
+ These guidelines will help you send a pull request.
6
+
7
+ If you're submitting an issue instead, please skip this document.
8
+
9
+ If your pull request is related to a typo or the documentation being unclear, please click on the relevant page's ` Edit `
10
+ button (pencil icon) and directly suggest a correction instead.
11
+
12
+ This project was made with ❤️. The simplest way to give back is by starring and sharing it online.
13
+
14
+ Everyone is welcome regardless of personal background. We enforce a [ Code of conduct] ( CODE_OF_CONDUCT.md ) in order to
15
+ promote a positive and inclusive environment.
16
+
17
+ ## Development process
18
+
19
+ First fork and clone the repository. If you're not sure how to do this, please watch
20
+ [ these videos] ( https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github ) .
21
+
22
+ Run:
23
+
24
+ ``` bash
25
+ npm install
26
+ ```
27
+
28
+ Make sure everything is correctly setup with:
29
+
30
+ ``` bash
31
+ npm test
32
+ ```
33
+
34
+ ## How to write commit messages
35
+
36
+ We use [ Conventional Commit messages] ( https://www.conventionalcommits.org/ ) to automate version management.
37
+
38
+ Most common commit message prefixes are:
39
+
40
+ * ` fix: ` which represents bug fixes, and generate a patch release.
41
+ * ` feat: ` which represents a new feature, and generate a minor release.
42
+ * ` feat!: ` , ` fix!: ` or ` refactor!: ` and generate a major release.
43
+
44
+ ## Releasing
45
+
46
+ 1 . Merge the release PR
47
+ 2 . Run ` npm publish `
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments