Skip to content

Commit 3aad85c

Browse files
Nick Balestrageovanisouza92
authored andcommitted
docs(META): Contributing guidelines doc
ISSUES CLOSED: #26
1 parent 571af8b commit 3aad85c

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
First of all, thank you for contributing. It’s appreciated.
2+
3+
# To submit a pull request
4+
5+
1. Open a GitHub issue before doing significant amount of work.
6+
2. Clone the repo. If it was already cloned, then git pull to get the latest from master.
7+
4. Run `npm install`.
8+
5. Write code.
9+
6. Run `npm test` to lint and test. Don’t commit before fixing all errors and warnings.
10+
7. Commit using `npm run commit` and follow the CLI instructions.
11+
8. Make a pull request.
12+
13+
# To release new versions
14+
15+
1. Check that you have npm publishing rights before anything else.
16+
2. Run `npm run check-release`.
17+
3. Run `npm run release`.

0 commit comments

Comments
 (0)