Skip to content

Latest commit

 

History

History
77 lines (59 loc) · 3.69 KB

CONTRIBUTING.md

File metadata and controls

77 lines (59 loc) · 3.69 KB
Raw

Contribution Guide

Thank you for contributing to the Hacking Tools repository! This project aims to gather, develop, and organize a comprehensive set of tools for ethical hacking, cybersecurity, and penetration testing. Contributions from the community make this repository valuable and diverse. This guide provides an overview of how you can contribute effectively.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. Types of Contributions
  4. How to Contribute
  5. Submission Guidelines
  6. Community and Support

1. Code of Conduct

Please read and respect our Code of Conduct. All contributors are expected to maintain a respectful, inclusive environment. Ethical considerations are paramount—our tools are intended for legal and educational purposes only.

2. Getting Started

  1. Fork the Repository: Start by forking the repository to your GitHub account.
  2. Clone Your Fork: Clone your forked repository to your local machine: 
    git clone https://github.com/aw-junaid/Hacking-Tools
  3. Switch to the Master Branch: Ensure you are working on the master branch. 
    git checkout master
  4. Install Dependencies: Follow any installation instructions in the repository to set up the environment.

3. Types of Contributions

We welcome various types of contributions, including:

  • New Tools: Adding a new tool for hacking or penetration testing.
  • Documentation: Improving or expanding documentation, tutorials, and guides.
  • Bug Fixes: Resolving issues with existing tools or scripts.
  • Enhancements: Adding new features to existing tools or improving performance.
  • Testing: Writing test cases for tools to ensure reliability and accuracy.

4. How to Contribute

Adding a New Tool

  1. Create a New Folder: Add your tool in a new folder under tools/. Name it descriptively (e.g., tools/port-scanner/).
  2. Include Documentation: Every tool should have a README.md file explaining:
    • Purpose of the tool
    • Installation instructions
    • Usage instructions
    • Examples of output
  3. Add Licensing Information: Ensure that the tool complies with licensing policies. Include any required attribution or licensing information within your tool’s folder.

Improving Documentation

  • Add examples, descriptions, or details to help others understand how to use the tools.
  • Ensure any technical terms or concepts are clearly explained.

Bug Fixes and Enhancements

  • Review the open issues to find bugs or improvement suggestions. Provide details in your update about what you fixed or improved.
  • Make sure your updates do not introduce new bugs.

5. Submission Guidelines

  1. Run Tests: Ensure that all tests pass before pushing your changes.
  2. Write Clear Commit Messages: Use concise, descriptive commit messages. Example: 
    git commit -m "Added new port scanning tool with usage instructions"
  3. Push to the Master Branch:
    • Push your changes directly to the master branch: 
      git push origin master
  4. Create a Pull Request (Optional): If you'd like feedback or a review from maintainers, you can create a pull request on your forked repository, although this is optional in a direct-to-master workflow.

6. Community and Support

Join our GitHub Discussions or reach out via issues to discuss ideas, ask questions, or get guidance. We value and support all contributions—whether big or small!