teloxide/CONTRIBUTING.md

21 lines
1.1 KiB
Markdown
Raw Normal View History

2020-02-03 13:07:44 +01:00
# Contributing
2020-02-19 03:04:31 +01:00
Before contributing, please read [our code style](https://github.com/teloxide/teloxide/blob/master/CODE_STYLE.md) and [the license](https://github.com/teloxide/teloxide/blob/master/LICENSE).
2020-02-03 13:07:44 +01:00
2020-02-19 21:12:27 +01:00
To change the source code, fork this repository and work inside your own branch. Then send us a PR into the [dev](https://github.com/teloxide/teloxide/tree/dev) branch and wait for the CI to check everything. However, you'd better check changes first locally:
2020-02-03 13:07:44 +01:00
```
cargo clippy --all --all-features --all-targets
cargo test --all
cargo doc --open
2020-02-14 09:43:31 +01:00
cargo fmt --all -- --check
2020-02-03 13:07:44 +01:00
```
2020-02-14 11:45:45 +01:00
To report a bug, suggest new functionality, or ask a question, go to [Issues](https://github.com/teloxide/teloxide/issues). Try to make MRE (**M**inimal **R**eproducible **E**xample) and specify your teloxide version to let others help you.
2020-02-19 02:10:06 +01:00
And don't forget to switch to the nightly channel in order to be able to run `cargo fmt` (because our [rustfmt.toml](https://github.com/teloxide/teloxide/blob/master/rustfmt.toml) requires some nightly-only functionality):
```bash
$ rustup override set nightly
```