Thank you for considering contributing to Redvin! Please read these guidelines before submitting a pull request or opening an issue.
Codes should follow cargo fmt style and all of new code should have tests that pass.
Please follow these guidelines when committing changes to Redvin:
- Each commit should represent a single, atomic change to the codebase. Avoid making multiple unrelated changes in a single commit.
- Use the Conventional Commits format for commit messages and Pull Request titles.
List of conventional commit types:
| Types | Description |
|---|---|
| fix | A big fix |
| feat | A new feature |
| docs | Documentation only changes |
| test | Adding missing tests or correcting existing tests |
| build | Changes that affect the build system or external dependencies |
| ci | Changes to our CI configuration files and scripts |
| perf | A code change that improves performance |
| refactor | A code change that neither fixes a bug nor adds a feature |
| style | Changes that do not affect the meaning of the code (white-space, formatting, etc) |
| chore | Other changes that don't modify src or test files |
This project has adapted the Contributor Covenant, version 2.1 to ensure that our community is welcoming and inclusive for all. Please read it before contributing to the project.
Thank you for your contributions to IPNN and Redvin!