Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (30 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 2.33 KB

Contributing to Pentest Copilot

Firstly, thank you for considering contributing to Pentest Copilot! As an open-source project, we thrive on the contributions of community members like you. Whether it's fixing bugs, adding new features, or improving documentation, every contribution is valuable.

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

  • Git
  • Node.js 22+
  • Docker

Setting Up Your Development Environment

Follow the instructions in the README to set up Pentest Copilot on your local machine.

How to Contribute

Reporting Bugs

If you find a bug in the software:

  1. Check the Issues page to see if it has already been reported.
  2. If not, open a new issue and provide a detailed description of the bug, including steps to reproduce it.

Suggesting Enhancements

We love new ideas! To suggest enhancements:

  1. Check if your idea is already being discussed in the Issues.
  2. If not, open a new issue and label it as a feature request.
  3. Clearly describe the feature and its benefits.

Pull Requests

  1. Fork the Repository: Click the 'Fork' button at the top right of the GitHub page to create your own copy of the repository.
  2. Create a Branch: From your fork, create a branch to work on your contribution. Name it appropriately based on what you're working on (e.g., feature-add-scanner, bugfix-recon-error).
  3. Make Your Changes: Implement your changes, adhering to the existing code style and standards.
  4. Test Your Changes: Ensure your changes don’t break any existing functionality. Add any relevant tests if necessary.
  5. Commit Your Changes: Use clear and concise commit messages.
  6. Push to Your Branch: Upload your changes to your fork.
  7. Open a Pull Request: Go to the original Pentest Copilot repository, and you’ll see a prompt to open a pull request from your new branch. Provide a detailed description of your changes and why they’re necessary.

License

By contributing to Pentest Copilot, you agree that your contributions will be licensed under its MIT License.