Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 1.42 KB
Raw

Contributing Guidelines

Welcome to PentestGPT!

We appreciate your interest in contributing to our project.

Before you get started, please read our guidelines for contributing.

Types of Contributions

We welcome the following types of contributions:

  • Bug fixes
  • New features
  • Documentation improvements
  • Code optimizations
  • Translations
  • Tests

Getting Started

To get started, fork the project on GitHub and clone it locally on your machine. Then, create a new branch to work on your changes.

git clone https://github.com/hackerai-tech/PentestGPT
cd PentestGPT
git checkout -b my-branch-name

Before submitting your pull request, please make sure your changes pass our automated tests and adhere to our code style guidelines.

Pull Request Process

  1. Fork the project on GitHub.
  2. Clone your forked repository locally on your machine.
  3. Create a new branch from the main branch.
  4. Make your changes on the new branch.
  5. Ensure that your changes adhere to our code style guidelines and pass our automated tests.
  6. Commit your changes and push them to your forked repository.
  7. Submit a pull request to the main branch of the main repository.

Format Code

Format the code with Prettier before submitting a pull request.

npm run clean

Contact

You can get in touch with us through email at contact@hackerai.co or connect with us on X.