Skip to content

Commit ae667a5

Browse files
authored
Create CONTRIBUTING.md (projectdiscovery#3968)
1 parent 1635a2f commit ae667a5

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing to ProjectDiscovery/Nuclei
2+
3+
We appreciate your interest in contributing to the projectdiscovery/nuclei! This document provides some basic guidelines for contributors.
4+
5+
## Getting Started
6+
7+
- Always base your work from the `dev` branch, which is the development branch with the latest code.
8+
- Before creating a Pull Request (PR), make sure there is a corresponding issue for your contribution. If there isn't one already, please create one.
9+
- Include the problem description in the issue.
10+
11+
## Pull Requests
12+
13+
When creating a PR, please follow these guidelines:
14+
15+
- Link your PR to the corresponding issue.
16+
- Provide context in the PR description to help reviewers understand the changes. The more information you provide, the faster the review process will be.
17+
- Include an example of running the tool with the changed code, if applicable. Provide 'before' and 'after' examples if possible.
18+
- Include steps for functional testing or replication.
19+
- If you're adding a new feature, make sure to include unit tests.
20+
21+
## Code Style
22+
23+
Please adhere to the existing coding style for consistency.
24+
25+
## Questions
26+
27+
If you have any questions or need further guidance, please feel free to ask in the issue or PR, or [reach out to the maintainers](https://discord.gg/projectdiscovery).
28+
29+
Thank you for your contribution!
30+

0 commit comments

Comments
 (0)