Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (38 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 2.14 KB

Contributing

Thank you for your interest in improving this project. This document explains how to contribute effectively while preserving attribution and legal clarity.

Ground rules

  • Use this project only for authorized security research, education, and contracted penetration testing.
  • Do not submit content intended to facilitate unauthorized access to systems.
  • Follow the Code of Conduct in all interactions.

How to contribute

  1. Open an issue first for substantial changes (new features, large refactors).
  2. Fork the repository and create a feature branch from the default branch (main or master as documented in the README).
  3. Keep commits focused — one logical change per commit when possible.
  4. Test your changes locally before opening a pull request.
  5. Open a pull request with a clear description, rationale, and references to related issues.

Pull request checklist

  • Code or documentation changes are scoped and documented.
  • No secrets, API keys, or real customer data are included.
  • License headers and third-party notices are preserved where required.
  • You agree that your contributions are licensed under the same terms as this repository (see LICENSE), unless explicitly stated otherwise.

Attribution and credits

  • Original author (Andre Henrique / @mrhenrike) retains credit as shown in README.md, commit history, and release notes.
  • When you contribute, you may be credited in release notes or the README at maintainer discretion.
  • Do not remove copyright or license notices from upstream or third-party files.

Style and documentation

  • Default documentation language for issues and primary README: English (en-US).
  • Portuguese (pt-BR) companion docs may exist where noted (e.g. README.pt-BR.md).
  • Use clear, technical language; prefer examples over vague descriptions.

Security disclosures

If you discover a security vulnerability in this project, do not open a public issue. Contact the maintainer through the channel indicated in the repository README.

Questions

Open an Issue on GitHub for process questions.