Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (51 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

78 lines (51 loc) · 2.54 KB

iHBV welcomes contributions that improve capability, reliability, and real-world utility. We value clean implementation, practical thinking, and disciplined engineering.

Contributing to iHBV

Thanks for your interest in contributing to iHBV.

We build security tooling, automation, and research-driven projects with an emphasis on clarity, reliability, and real-world utility. Contributions should support those goals.

Before You Contribute

Before opening a pull request, please make sure your contribution is:

  • Relevant to the purpose of the project
  • Clear in scope and implementation
  • Tested where appropriate
  • Documented where needed
  • Consistent with the style and structure of the repository

For large changes, feature proposals, or architectural changes, open an issue first so the direction can be discussed before implementation work begins.

Types of Contributions

Contributions may include:

  • Bug fixes
  • Documentation improvements
  • Refactoring
  • Tests
  • Performance improvements
  • New features aligned with project goals
  • Research-informed enhancements

Issues

When opening an issue, provide enough context for the problem to be understood and reproduced. Helpful issue reports usually include:

  • A clear summary
  • Expected behavior
  • Actual behavior
  • Reproduction steps
  • Environment details, if relevant
  • Logs, screenshots, or output where useful

Pull Requests

To help keep reviews efficient and changes maintainable:

  • Keep pull requests focused and reasonably scoped
  • Write clear commit messages
  • Include context for why the change is needed
  • Update documentation if behavior or usage changes
  • Add or update tests when practical

Pull requests may be reviewed for correctness, maintainability, project fit, and operational value.

Style and Quality

We value contributions that are:

  • Practical
  • Readable
  • Modular
  • Well-reasoned
  • Aligned with the repository's purpose

Avoid unnecessary complexity, dead code, unrelated changes, or large speculative additions without prior discussion.

Security-Related Contributions

Do not disclose vulnerabilities publicly through issues or pull requests. If your contribution relates to a security issue, follow the process described in SECURITY.md.

Code of Conduct

Contributors are expected to engage professionally and constructively. Clear communication, technical rigor, and mutual respect are expected in all discussions and reviews.

Licensing

By contributing, you agree that your contributions may be released under the license of the relevant repository unless stated otherwise.