Skip to content
This repository was archived by the owner on Oct 3, 2023. It is now read-only.

Commit afc3268

Browse files
mhdawsonmayurkale22
authored andcommitted
doc: add some use info to CONTRIBUTING.md (#531)
* doc: add some use info to CONTRIBUTING.md Adding some information that would have been useful to me when I was working on my first commit. * squash: add information about using `npm run fix`
1 parent e5ff47c commit afc3268

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,8 @@ Follow either of the two links above to access the appropriate CLA and instructi
2626
1. Submit an issue describing your proposed change to the repo in question.
2727
1. The repo owner will respond to your issue promptly.
2828
1. Fork the desired repo, develop and test your code changes.
29+
1. In the directory for each of the packages that you have made changes in, run `npm run test` to run the tests and check coverage. Ensure there are no new failures after your changes.
30+
1. From the top level directory run `npm run check` and address any failures. This builds all of the packages and runs the linter. This ensures changes you have made do not affect any of the packages (which can happen even if you have not changed them specifically).
31+
1. The easiest way to fix linter errors is to run `npm run fix`
2932
1. Submit a pull request.
30-
1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
33+
1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).

0 commit comments

Comments
 (0)