Thank you for your interest in contributing to Chia! We welcome contributions from the community and are grateful for your support.
This document provides guidelines and instructions for contributing.
- AI-Assisted Contributions Policy
- Reporting Security Vulnerabilities
- Testing & Dockerfile Requirements
- Documentation
- Reporting Bugs
- Suggesting Features
- Getting Help
You MAY use AI assistance for contributing to Chia, as long as you follow the principles described below.
Accountability: You MUST take the responsibility for your contribution. The contributor is always the author and is fully accountable for the entirety of these contributions.
Transparency: You MUST disclose the use of AI tools when the significant part of the contribution is taken from a tool without changes.
Contribution & Community Evaluation: AI tools may be used to assist human reviewers by providing analysis and suggestions. You MUST NOT use AI as the sole or final arbiter in making a substantive or subjective judgment on a contribution.
Please do not report security vulnerabilities through public GitHub issues.
For information on how to report security vulnerabilities, please see our SECURITY.md file. We take security issues seriously and will respond promptly to your report.
Contributions to chia should have tests in the corresponding chia/subfolder/tests folder.
New dockerfiles in dockerfiles should have a corresponding .github/workflows action.
Good documentation is essential. Please update documentation under the docs/ folder if your contributions affect the documented behavior.
Contributions to chia that modify classes or user-facing functions (function names that do not start with an underscore _) should have docstrings describing arguments.
Before reporting a bug, please:
- Search existing issues to see if the bug has already been reported.
- Check if the bug has been fixed in the latest version.
Use the bug report template when opening a new issue.
We welcome feature suggestions! Before submitting a feature request:
- Search existing issues to see if the feature has already been requested.
- Consider whether the feature aligns with the project's goals and scope.
Use the feature request template when opening a new issue.
If you need help with your contribution:
- Documentation: Review the project documentation
- Issues: Search or open an issue
- Mailing List: Reach out on our mailing list
Thank you for contributing to Chia! Your efforts help make this project better for everyone.