Skip to content

Latest commit

 

History

History
77 lines (59 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

77 lines (59 loc) · 3.76 KB
Raw

Welcome to the Amphion Community!

We greatly appreciate your interest in contributing to Amphion. Your involvement plays a pivotal role in our collective growth, and we are dedicated to nurturing a cooperative and inclusive space for all contributors. To ensure a respectful and productive atmosphere, all contributors must adhere to the Amphion Code of Conduct.

Contributions

All kinds of contributions are welcome, including but not limited to:

  • Issue Reporting: Report bugs or suggest features through GitHub Issues.

  • Bug Fixes: Identify and rectify software issues to boost functionality.

  • Developing New Features: Bring innovation and impactful enhancements to Amphion.

  • Implementing New Checkpoints: Introduce checkpoints to optimize workflows.

  • Recipe Contributions: Share your unique and practical coding solutions.

  • Diverse Contributions: Your participation isn't limited! Contribute to documentation, community support, and more.

How to Contribute

  1. Fork the Repository: Start by forking the Amphion repository on GitHub.
  2. Clone Your Fork: Localize your fork on your development machine.
  3. Create a Branch: Initiate a new branch for your changes.
  4. Test Your Changes: Ensure compatibility and non-disruption of your updates.
  5. Commit Your Changes: Make small, focused commits with clear descriptions.
  6. Update Your Fork: Upload your modifications to your GitHub fork.
  7. Open a Pull Request: Suggest a pull request from your fork to the main Amphion repository with our Pull Request Template.
  8. Participate in Code Reviews: Collaborate with reviewers and address their feedback.

Coding Standards

  • License Headers: Each new code file should include license headers.
  • Style Consistency: Align with the project's existing coding style.
  • Code Quality: Aim for clarity, maintainability, and efficiency.
  • Clear Commenting: Describe the purpose and usage of each function and other crucial code segments.
  • Code Formatting:
    • Install 'black' formatter: pip install black.
    • Format files: black file.py.
    • Format directories: black directory/.

Contributor Agreement

By contributing to Amphion, you agree to abide by our Code of Conduct, and the Developer Certificate of Origin, Version 1.1:

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.

Need Help?

For any queries or support, feel free to open an issue for community discussions and help.