Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (34 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

62 lines (34 loc) · 1.53 KB

Contributing to Auto-Payload-Positioner

Thank you for considering contributing to the project! We welcome contributions that improve functionality, performance, documentation, or overall code quality.

How to Contribute

  1. Fork the repository

    • Click "Fork" at the top-right of the repository page.

  2. Clone your fork

    git clone https://github.com/your-username/Auto-Payload-Positioner.git

# Create a new branch
git checkout -b your-feature-branch

  3. Make your changes

    • Follow the coding style used in the project.

    • Keep commits atomic and meaningful.

    • Add/update tests if necessary.

    • Update documentation if behavior changes.

  4. Test your changes

    • Make sure everything builds and works properly.

    • Run existing tests and new ones you add.

  5. Submit a Pull Request

    • Push your branch to your fork.

    • Open a pull request against the main branch.

    • Fill out the Pull Request Template.

  6. Code Style and Practices

    • Write clear, concise commit messages.

    • Keep pull requests focused and small.

    • Document any new features or major changes.

    • Maintain backward compatibility where possible.

Development Requirements

  • JDK 17

  • Familiarity with BurpSuite Extension Development with new Montoya API, legacy API is not allowed.

Communication

If you plan to contribute a larger feature or change, please open an issue first to discuss it.

Thanks for helping make this project better! You are awesome and thanks in advance.