Skip to content

CONTRIBUTION.md

Latest commit

 

History

History
49 lines (32 loc) · 2.06 KB

CONTRIBUTION.md

File metadata and controls

49 lines (32 loc) · 2.06 KB

Contributing to US Health Index (USHX) Repository

Thank you for your interest in contributing to the US Health Index (USHX) repository. By contributing, you help improve documentation, methodology transparency, and the overall robustness of this institutional-grade benchmark.

How to Contribute

  1. Reporting Issues

    • Use the Issues tab to report bugs, data discrepancies, or documentation errors.
    • Clearly describe the problem and provide supporting details or references.

  2. Proposing Changes

    • Fork the repository and create a branch for your changes.
    • Submit a Pull Request (PR) with clear descriptions of your proposed changes.
    • Include references to relevant sections of the Whitepaper or Benchmark Analysis if applicable.

  3. Code Contributions

    • Ensure any code additions are consistent with BEP-20/ERC-20 standards, and UUPS upgradeable patterns.
    • Include thorough comments, unit tests, and adhere to OpenZeppelin best practices.
    • Ensure that code changes do not alter index methodology logic unless clearly justified and reviewed.

  4. Documentation Contributions

    • Updates to the Whitepaper, Benchmark Analysis, or README must maintain accuracy, clarity, and institutional-grade language.
    • Add new sections only if they are consistent with the current methodology and governance framework.

  5. Review Process

    • All contributions are subject to review by the USHX core maintainers.
    • Contributors may be asked for clarifications, revisions, or additional references before a PR is approved.

Code of Conduct

All contributors are expected to adhere to professional and respectful conduct. This includes:

  • Open, constructive discussion
  • Respect for diverse perspectives
  • Maintaining institutional integrity in documentation and code

License

By contributing, you agree that your contributions will be licensed under the repository's MIT License.

Thank you for helping make USHX a transparent, auditable, and institutional-grade benchmark.