Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (37 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

50 lines (37 loc) · 1.68 KB

Contributing to Pentest Agent System

We welcome contributions to the Pentest Agent System! This document outlines the guidelines for contributing to the project.

How to Contribute

  1. Fork the Repository:

    • Click the "Fork" button on the top right of the repository page to create your own copy of the repository.

  2. Clone Your Fork:

    git clone https://github.com/your-username/pentest-agent-system.git
cd pentest-agent-system

  3. Create a New Branch:

    • It's best practice to create a new branch for your changes:
    git checkout -b feature/your-feature-name

  4. Make Your Changes:

    • Implement your feature or fix a bug. Ensure that your code adheres to the project's coding standards.

  5. Test Your Changes:

    • Run any existing tests to ensure your changes do not break the application. If you add new features, consider adding tests for them as well.

  6. Commit Your Changes:

    git add .
git commit -m "Add your descriptive commit message"

  7. Push to Your Fork:

    git push origin feature/your-feature-name

  8. Create a Pull Request:

    • Go to the original repository where you want to propose your changes.
    • Click on the "Pull Requests" tab and then click "New Pull Request".
    • Select your branch and submit the pull request.

Code of Conduct

Please adhere to the Code of Conduct in all interactions related to the project.

Issues

If you find a bug or have a feature request, please open an issue in the repository. Provide as much detail as possible to help us understand the problem.

Thank you for contributing to the Pentest Agent System!