Thank you for your interest in contributing to Bolt!
We welcome contributions at all levels. Whether you’re a beginner or an experienced developer, your input is valued. This guide will help you get started.
If you have questions or need help, feel free to reach out to the team on Discord.
Bolt adheres to the Rust Code of Conduct. Please ensure your interactions are respectful and constructive.
Violations of the Code of Conduct can be reported by contacting the team.
There are several ways you can contribute:
-
Report an Issue
If you’ve found a bug or have feedback, open an issue in the issue tracker. Be sure to include relevant details like your environment and steps to reproduce the issue. -
Contribute Code
Fix bugs, improve performance, or add new features by submitting a pull request. -
Resolving Issues
If you're interested in resolving an issue, please comment on the issue to let us know you want to work on it and outline a plan for tackling it. A good place to start looking for work is issues labeled with good first issue.
We do not accept contributions focused solely on fixing typos or minor grammatical errors in documentation or code comments.
Before submitting a pull request:
- Make sure your changes are logically grouped and adhere to Rust standards (e.g., run
just fmtandjust clippy). - Include tests for any new functionality or bug fixes.
- Consider opening a draft pull request if your work is ongoing or you’d like early feedback.
- Consider running the devnet locally when testing.
- We use conventional commits for commit messages.
If your changes include code updates, ensure they are properly tested:
- Unit Tests: For individual functions or components.
- Integration Tests: For larger, cross-functional features.
Run just test locally to confirm all tests pass.
By contributing to Bolt, you agree to license your contributions under MIT license.
Thank you for helping make Bolt better!