Skip to content

Commit 0b2799c

Browse files
skoloCFDjourdain
authored andcommitted
docs: update CONTRIBUTING.m to document the NPM RUN REFORMAT step required in the PR checklist
It is possible to follow the CONTRIBUTING.md instructions, but still end up with an invalid PR due to formatting issues. The PR checklist fixes this, but these instructions can be presented earlier on in the process v
1 parent 8767f43 commit 0b2799c

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,27 +33,34 @@ Please follow the coding style:
3333
$ git checkout -b new_feature
3434
```
3535

36-
4. Start hacking. Additional information on how to create class/test/example can be found
36+
6. Start hacking. Additional information on how to create class/test/example can be found
3737
[here](https://kitware.github.io/vtk-js/docs/) in the __Development__ section.
3838

3939
```sh
4040
$ edit file1 file2 file3
4141
$ git add file1 file2 file3
4242
```
4343

44-
5. Use Commitizen to create commits
44+
7. Verify you have correctly formatted code, and that all tests pass:
45+
46+
```sh
47+
$ npm run reformat
48+
$ npm run test
49+
```
50+
51+
8. Use Commitizen to create commits
4552

4653
```sh
4754
$ npm run commit
4855
```
4956

50-
6. Push commits in your feature branch to your fork in GitHub:
57+
9. Push commits in your feature branch to your fork in GitHub:
5158

5259
```sh
5360
$ git push origin new_feature
5461
```
5562

56-
7. Visit your fork in Github, browse to the "**Pull Requests**" link on the left, and use the
63+
10. Visit your fork in Github, browse to the "**Pull Requests**" link on the left, and use the
5764
"**New Pull Request**" button in the upper right to create a Pull Request.
5865

5966
For more information see:
@@ -62,7 +69,7 @@ Please follow the coding style:
6269
If committing changes to `vtk.js@next` or `vtk.js@next-major`, then set your base branch to be `next`
6370
or `next-major`, respectively. For more info see the section on release channels below.
6471

65-
8. vtk.js uses GitHub for code review and Github Actions to validate proposed patches before they are merged.
72+
11. vtk.js uses GitHub for code review and Github Actions to validate proposed patches before they are merged.
6673

6774
## Release Channels
6875

0 commit comments

Comments
 (0)