teloxide/CONTRIBUTING.md
2020-03-27 18:45:42 +06:00

1 KiB

Contributing

Before contributing, please read our code style and the license.

To change the source code, fork the master branch of this repository and work inside your own branch. Then send us a PR into master branch and wait for the CI to check everything. However, you'd better check changes first locally:

cargo clippy --all --all-features --all-targets
cargo test --all
cargo doc --open
cargo fmt --all -- --check

To report a bug, suggest new functionality, or ask a question, go to Issues. Try to make MRE (Minimal Reproducible Example) and specify your teloxide version to let others help you.

And don't forget to switch to the nightly channel in order to be able to run cargo fmt (because our rustfmt.toml requires some nightly-only functionality):

$ rustup override set nightly