CONTRIBUTING.md

Contribution guide

There are many ways to contribute to this project. Thanks to everyone who has contributed! If you have any questions, please contact me at [email protected].

There is a matrix server for this project here and a discord server here.

Please follow the Code of Conduct.

Give feedback

The best way to give feedback is to open an issue on GitHub. Please report any bug you find here.

If you have a feature that you would like to see added, please open an issue here.

Write documentation

Documentation is important for users to understand the program and its features. The documentation is written in markdown, a simple markup language. It can be found in the docs folder.

To start, please install pnpm.

Get started by running:

cd docs
pnpm install
pnpm start

All stable documentation can be found in the versioned_docs folder.

Fork the project and create a pull request to add your documentation to the develop branch.

Code

This project is written in Rust. The cli source code can be found in the cli folder.

To get started, run:

cd cli
cargo build

Fork the project and create a pull request to add your code to the develop branch.