1 | # Contributing
|
2 |
|
3 | :+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
|
4 |
|
5 | The following is a set of guidelines for contributing to is-website-vulnerable.
|
6 | These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
|
7 |
|
8 | ## Code of Conduct
|
9 |
|
10 | This project and everyone participating in it is governed by a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
11 |
|
12 | ## How to contribute to is-website-vulnerable
|
13 |
|
14 |
|
15 |
|
16 | ### Tests
|
17 |
|
18 | Make sure you the code you're adding has decent test coverage.
|
19 |
|
20 | Running project tests and coverage:
|
21 |
|
22 | ```bash
|
23 | npm run test
|
24 | ```
|
25 |
|
26 | ### Commit Guidelines
|
27 |
|
28 | The project uses the commitizen tool for standardizing changelog style commit
|
29 | messages so you should follow it as so:
|
30 |
|
31 | ```bash
|
32 | git add . # add files to staging
|
33 | npm run commit # use the wizard for the commit message
|
34 | ```
|