Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (61 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

78 lines (61 loc) · 2.9 KB

cuik-molmaker contribution rules

Thank you for your interest in contributing to cuik-molmaker! Here are guidelines for contributing:

Reporting Bugs

  1. Check if the bug has already been reported in the Issues section
  2. If not, create a new issue with:
    • A clear and descriptive title
    • Steps to reproduce the bug
    • Expected behavior vs actual behavior
    • Your environment details (OS, Python version, package versions)
    • Any relevant error messages or logs

Making Contributions

  1. Fork the repository and create a new branch from main

  2. Make your changes following our code style:

    • Lint all files that are added or modified. We use black, isort, flake8 for python and clang-format for C++ code.
      • First time only: pre-commit install
      • pre-commit run --all-files
    • Add comments for complex logic
    • Follow existing naming conventions
    • Add tests for new functionality

  3. Before submitting a PR:

    • Run all tests locally
    • Update documentation if needed
    • Ensure code builds without warnings
    • Add a clear commit message describing your changes

  4. Submit a Pull Request:

    • Reference any related issues
    • Describe what the PR does and why
    • List any breaking changes
    • Include before/after examples if relevant

  5. The PR will be reviewed by maintainers who may request changes

Code Review Process

  • All submissions require review
  • Maintainers will review PRs regularly
  • Address review feedback promptly
  • PRs must pass all automated checks

For questions, feel free to open a discussion in the repository.

Developer Certificate of Origin

Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.