Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

51 lines (30 loc) · 3.02 KB
Raw

Contributing to ethical_hacking_pentesting_python

Thank you for your interest in contributing to this project! Below are some guidelines to help you get started.

Ethical and Legal Guidelines

This project focuses on ethical hacking, cybersecurity, and pentesting. As a contributor, it is essential to adhere to the following principles:

  1. Follow the Law: All contributions must comply with current security and privacy legislation. Any code or techniques developed should be intended for use in authorized environments only.

  2. Respect User Privacy: Never attempt to exploit vulnerabilities in unauthorized systems. This project is strictly for educational and professional ethical hacking, so privacy must always be respected.

  3. Use Disclaimers: If your contribution involves sensitive security areas, include clear disclaimers indicating that the code is intended for ethical hacking and should not be used maliciously.

  4. Ethical Practices: Ensure that any tools or scripts created as part of the project are used with explicit permission from the system owner.

How to Contribute

  1. Fork the Repository: Start by forking the project repository on GitHub.

  2. Create a New Branch: Make sure to create a new branch for each feature or fix.

    git checkout -b feature-or-bugfix-branch

  3. Code Style: Follow PEP8 guidelines for Python code formatting. Make sure your code is clean and well-documented.

  4. Testing: Ensure all code is tested thoroughly. If you add new functionality, include unit tests and run them before submitting your changes.

  5. Submit a Pull Request: After making your changes, submit a pull request (PR) with a clear description of the feature or fix. Explain why it’s needed, and reference any issues or discussion threads if relevant.

  6. Code Reviews: Please be open to feedback during the code review process. Code reviews help maintain high standards and foster collaboration.

  7. Documentation: Always update relevant documentation when you add or change functionality.

Reporting Issues

If you find a bug or security issue, please open a new issue on GitHub with a detailed description. Be mindful of responsible disclosure practices.

Code of Conduct

This project is governed by a Code of Conduct to foster an inclusive and respectful environment. By contributing, you agree to abide by its terms.

Key Sections in the File:

  • Ethical and Legal Guidelines: Emphasizes ethical conduct, including following the law and privacy standards.
  • How to Contribute: Clear steps for contributing code, including forking, creating branches, and submitting pull requests.
  • Testing and Documentation: Encourages contributors to write tests and update documentation.
  • Code of Conduct: Links to a CODE_OF_CONDUCT.md file to ensure contributors adhere to respectful communication and collaboration.

File Name:

The file should be saved as CONTRIBUTING.md at the root of your project’s repository on GitHub.