mirror/caddy-waf
1
0
Fork 0
mirror of https://github.com/fabriziosalmi/caddy-waf.git synced 2025-12-23 14:17:45 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source 
Contributing guidelines updated.
This commit is contained in:
fab
2025-01-22 23:47:26 +01:00
committed by GitHub
parent 37e58a7b0d
commit 4eed2bb915
1 changed files with 17 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md
View File

@@ -1 +1,17 @@
Please clone the repo, craete a feature branch and submit a PR once is ready to be integrated :)
# Contribute to the caddy-waf project!
You can contribute in many ways:
1. Testing the solution in different contexts and provide useful feedback.
2. Writing WAF rules and submitting a PR. Contribution rules must be saved to the `rules` folder.
3. Improving the documentation.
4. Opening an issue.
5. Improving the whole codebase, if something really big please provide additional context.
You already know the right way to submit a PR :)
- Clone the repository locally.
- Create a dedicated feature branch for your changes.
- Ensure your Pull Request (PR) passes all existing tests before submission.
Please note: I am actively developing and adding more tests to ensure comprehensive coverage. Your PR must pass the current test suite. Thank you for your contributions!