Skip to content

Commit fe01236

Browse files
authored
Create CONTRIBUTING.md
1 parent 0d9bc75 commit fe01236

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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 url-sheriff.
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 dssrf-js
13+
14+
By contributing to dssrf you should not compromise those rules.
15+
16+
### Security
17+
Ensure your changes do not introduce security risks or new ssrf bypasses to dssrf.
18+
19+
### Perfomance
20+
Ensure your changes do not slowdown dssrf or make request longer.
21+
22+
### FPS
23+
Ensure your changes not introduce false positives and block legitimate traffic and urls.
24+
25+
### Note
26+
your changes will be introduced in the new version after accepted in the github repo not in the actual one.
27+
28+
### Tests
29+
30+
Make sure the code you're adding has decent test coverage.
31+
32+
Running project tests and coverage:
33+
34+
```bash
35+
npm run test
36+
```

0 commit comments

Comments
 (0)