We're excited that you're interested in contributing to Valv! This document outlines the process for contributing to the project and provides some guidelines to ensure a smooth collaboration.
- Fork the repository on GitHub.
- Clone your fork locally:
git clone https://github.com/<USERNAME>/valv.git
- Create a new branch for your feature or bug fix:
git checkout -b your-branch-name
- Make your changes and commit them with a clear commit message.
- Push your changes to your fork:
git push origin your-branch-name
- Open a pull request against the main repository.
- Ensure you have Rust (latest stable version) and FoundationDB installed.
- Follow the "Getting Started" instructions in the README.md to set up the project.
- Ensure your code adheres to the project's coding standards and style guidelines.
- Update the README.md with details of changes to the interface, if applicable.
- Add or update tests as necessary to cover your changes.
- Ensure all tests pass before submitting your pull request.
- Your pull request will be reviewed by maintainers, who may request changes or ask questions.
- Check the GitHub Issues to see if the bug has already been reported.
- If not, create a new issue, providing a clear title and description.
- Include as much relevant information as possible, including steps to reproduce the bug.
- Check the GitHub Issues to see if the enhancement has already been suggested.
- If not, create a new issue, clearly describing the enhancement and its potential benefits.
- Follow Rust's official style guide and use
rustfmt
to format your code. - Write clear, self-documenting code and add comments where necessary.
- Ensure your code is properly tested.
By contributing to Valv, you agree that your contributions will be licensed under the Apache License 2.0.
If you have any questions about contributing, please open an issue or contact the maintainers.
Thank you for contributing to Valv!