You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,14 @@ This doc needs help! Please submit your PR...
4
4
5
5
## Commit messages
6
6
7
-
We are using semantic-release to automate the release process, and this depends on a specific format for commit messages. Please run `yarn commit` to use `commitizen` to properly format your commit messages so they can be automatically processed and included in release notes.
7
+
We are using semantic-release to automate the release process, and this depends on a specific format for commit messages. Please run `yarn cm` to use `commitizen` to properly format your commit messages so they can be automatically processed and included in release notes.
8
8
9
9
## Pull request testing
10
10
11
11
Some notes on testing and releasing.
12
-
* For a PR, follow Github's command-line instructions for retrieving the branch with the changes.
13
-
* To start a development server:
12
+
13
+
- For a PR, follow Github's command-line instructions for retrieving the branch with the changes.
14
+
- To start a development server:
14
15
15
16
```sh
16
17
yarn build
@@ -19,21 +20,20 @@ yarn
19
20
yarn start
20
21
```
21
22
22
-
* Provide feedback on the PR about your results.
23
+
- Provide feedback on the PR about your results.
23
24
24
25
## Doing a release
25
26
26
27
We are using semantic-release instead of this:
27
28
28
-
* update the version number in `package.json`
29
+
- update the version number in `package.json`
29
30
- Fixes update the patch number, features update the minor number.
30
31
- Major version update is reserved for API breaking changes, not just additions.
31
-
*`yarn github-changes -- -n 3.X.Y` to update the changelog
32
-
*`git add`, `git commit` and `git push` to get the version to master.
33
-
*`git tag -a 3.X.Y -m 3.X.Y``git push --tags`
34
-
*`npm publish`
35
-
* add a version on the github release page, based on the tag
36
-
32
+
-`yarn github-changes -- -n 3.X.Y` to update the changelog
33
+
-`git add`, `git commit` and `git push` to get the version to master.
34
+
-`git tag -a 3.X.Y -m 3.X.Y``git push --tags`
35
+
-`npm publish`
36
+
- add a version on the github release page, based on the tag
0 commit comments