Skip to content

Commit 50b207c

Browse files
authored
Create CONTRIBUTING.md
1 parent bff7895 commit 50b207c

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing to NetSentry-Framework
2+
3+
First off, thank you for considering contributing to Net-Sentry! It's people like you who make it a powerful tool for the security community.
4+
5+
### How Can I Contribute?
6+
7+
#### Reporting Bugs
8+
* Check the **Issues** tab to see if the bug has already been reported.
9+
* If not, open a new issue. Clearly describe the bug, your environment (OS, Python version), and steps to reproduce it.
10+
11+
#### Suggesting Enhancements
12+
* Open an issue with the tag `enhancement`.
13+
* Explain why this feature would be useful and how it should work.
14+
15+
#### Pull Requests (Code Contributions)
16+
1. **Fork** the repository.
17+
2. Create a new branch (`git checkout -b feature/AmazingFeature`).
18+
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
19+
4. Push to the branch (`git push origin feature/AmazingFeature`).
20+
5. Open a **Pull Request**.
21+
22+
### Development Setup
23+
* Ensure you have **Python 3.10+** and **Nmap** installed.
24+
* Follow the installation steps in the main README.
25+
* We follow **PEP 8** coding standards for Python. Please ensure your code is clean and commented.
26+
27+
### License
28+
By contributing, you agree that your contributions will be licensed under its **MIT License**.

0 commit comments

Comments
 (0)