CONTRIBUTING.md

Contributing

Code of Conduct

Please note that this project is released with a Code of Conduct. By participating in this project you agree to abide by its terms.

Matrix room

Joining the matrix room at #pikelet:matrix.org is a good way to get in touch with the developers and community.

Prerequisites

We use Rust as our implementation language, which can be installed using the rustup tool.

For the best experience in working with Rust we also recommend installing IDE support for your editor of choice:

• Rust Analyzer (for VS Code, Vim Emacs, etc.)
• IntelliJ Rust (for IntelliJ-based IDEs)

You can learn more about programming in Rust by reading The Rust Programming Language.

Workflow

Follow these steps to contribute to the project:

1. Make a fork of the Pikelet repository.
2. Within your fork, create a branch for your contribution. Use a meaningful name.
3. Create your contribution, meeting all contribution quality standards.
4. Ensure all the tests pass (cargo test).
5. Create a pull request against the master branch of the repository.
6. Once the pull request is reviewed and CI passes, it will be merged.

Quality Standards

Most quality and style standards are checked automatically by the CI build. Contributions should:

• Separate each logical change into its own commit.
• Include tests for any new functionality in your pull request.
• Document public functions.
• Format code with cargo fmt.
• Avoid adding unsafe code. If it is necessary, provide an explanatory comment on any unsafe block explaining its rationale and why it's safe.
• Add a descriptive message for each commit. Follow these commit message guidelines.
• Document your pull requests. Include the reasoning behind each change, and the testing done.