Skip to content

Commit a2a0785

Browse files
authored
Create CONTRIBUTING.md
1 parent f9024db commit a2a0785

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing to OWASP CSRF Protector PHP
2+
CSRF Protector is a community project, and we are always delighted to welcome new contributors!
3+
4+
There are lots of ways you can contribute:
5+
6+
## Got a Question or Problem?
7+
If you have a question or problem relating to using this project then the first thing to do is to check:
8+
- **Project Wiki**: We have a comprehensive User Guide for CSRF Protector in our [Github Wiki](https://github.com/mebjas/CSRF-Protector-PHP/wiki).
9+
- **OWASP Wiki**: We have more information about the project and sibling projects at [https://www2.owasp.org/www-project-csrfprotector/](https://www2.owasp.org/www-project-csrfprotector/).
10+
- **Articles online**: We have some articles online on how to use or new features introduced like:
11+
- [CSRF Protector - concept design & future](https://blog.minhazav.dev/CSRF-Protector-concept-design-and-future/)
12+
- [Session based login compatibility issues with CSRF - how to mitigate](https://blog.minhazav.dev/logging-out-and-then-logging-in-throws-403-error-with-csrf-protector/)
13+
- [Minor improvements to CSRF Protector PHP](https://blog.minhazav.dev/introducing-minor-improvements-to-csrf-protector-php/)
14+
- **Google groups**: If they don't help then please ask on the [User Group](https://groups.google.com/a/owasp.org/forum/#!forum/csrfprotector-project)
15+
16+
## Found an Issue?
17+
If you have found a bug then raise an issue on the CSRF Protector repo: [https://github.com/mebjas/CSRF-Protector-PHP/issues](https://github.com/mebjas/CSRF-Protector-PHP/issues)
18+
19+
Its worth checking to see if its already been reported, and including as much information as you can to help us diagnose your problem.
20+
21+
## Found a Vulnerability?
22+
If you think you have found a vulnerability in CSRF Protector then please report it directly on email at [[email protected]](mailto:https://github.com/mebjas/CSRF-Protector-PHP/issues) or [[email protected]](mailto: [email protected])
23+
24+
We are always very grateful to researchers who report vulnerabilities responsibly and will be very happy to give credit for the valuable assistance they provide.
25+
26+
## Have a Feature Request?
27+
If you have a suggestion for new functionality then you can raise an issue on the CSRF Protector PHP repo: [https://github.com/mebjas/CSRF-Protector-PHP/issues](https://github.com/mebjas/CSRF-Protector-PHP/issues)
28+
29+
Its worth checking to see if its already been requested, and including as much information as you can so that we can fully understand your requirements.
30+
31+
## Become a CSRF Protector Evangelist
32+
Please feel free to write more about this project on how it works or how to use it. Please feel free to send a [pull request](https://github.com/mebjas/CSRF-Protector-PHP/pulls) by adding a reference to your article in the `README.md` or `CONTRIBUTING.md`.
33+
34+
## Help Improve the Documentation
35+
The source for the CSRF Protector OWASP wiki [User Guide is hosted at OWASP/www-project-csrfprotector](https://github.com/OWASP/www-project-csrfprotector) and is hosted at [https://www2.owasp.org/www-project-csrfprotector/](https://www2.owasp.org/www-project-csrfprotector/). Please feel free to send a [pull request](https://github.com/OWASP/www-project-csrfprotector/pulls) to add updates to the documentation.
36+
37+
## Coding
38+
39+
There's always lots of coding to be done! If you feel something can be improved feel free to send a pull request.

0 commit comments

Comments
 (0)