Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Hannah-PortSwigger authored Oct 10, 2023
1 parent f8bbc96 commit 22f318f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ Please note that we have a code of conduct. Please follow it in all your interac

1. Place your BCheck in the appropriate folder. For example, BChecks referencing CVEs should be placed in the `vulnerabilities-CVEd` folder.
2. Include a description of the BCheck you are adding in the pull request.
3. Make sure the BCheck follows our [Submission Guidelines](https://github.com/PortSwigger/BChecks/blob/main/CONTRIBUTING.md#submission-guidelines).
3. Make sure the BCheck follows our [Submission Guidelines](#submission-guidelines).
4. Engage with any comments and feedback given in the review.
5. If your pull request contains multiple BChecks, please be aware that you may be asked to split your PR. This would happen if some BChecks require further feedback while others are ready to merge.

## Submission Guidelines

1. Where possible, please ONLY link to the primary research.
2. Please make sure all metadata fields are completed.
3. Please make sure the BCheck is syntactically valid (see [BCheckChecker](https://github.com/PortSwigger/BChecks/blob/main/CONTRIBUTING.md#bcheckchecker)).
3. Please make sure the BCheck is syntactically valid (see [BCheckChecker](#bcheckchecker)).
4. Please make sure the BCheck is formatted correctly.
- Indentation is four spaces, not tabs.
5. Please make sure the BCheck is optimized.
Expand Down

0 comments on commit 22f318f

Please sign in to comment.