Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (62 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

91 lines (62 loc) · 3.03 KB

Contributing to VibeTensor

Thank you for your interest in contributing to VibeTensor!

Contribution Process

  1. Fork the repository and create your branch from main.
  2. Make your changes following the coding style of the project.
  3. Add tests for any new functionality.
  4. Ensure all tests pass.
  5. Submit a pull request.

Developer Certificate of Origin (DCO)

VibeTensor requires the Developer Certificate of Origin (DCO) process to be followed for all contributions.

The DCO is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing. The full text of the DCO can be found at https://developercertificate.org/.

DCO Sign-Off

All commits must be signed off by the contributor, certifying that you have the right to submit your contribution under the project's license.

To sign off a commit, add a Signed-off-by line to your commit message:

Signed-off-by: Your Name <your.email@example.com>

You can do this automatically by using the -s or --signoff flag when committing:

git commit -s -m "Your commit message"

Developer Certificate of Origin v1.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.

Code Style

  • Follow the existing code style in the repository
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions focused and modular

Reporting Issues

When reporting issues, please include:

  • A clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Environment details (OS, Python version, CUDA version, etc.)

License

By contributing to VibeTensor, you agree that your contributions will be licensed under the Apache License 2.0.