teloxide/CONTRIBUTING.md

16 lines
873 B
Markdown
Raw Normal View History

2020-02-03 13:07:44 +01:00
# Contributing
2020-08-17 17:10:03 +02:00
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-08-17 17:10:03 +02:00
To change the source code, fork the `dev` branch of this repository and work inside your own branch. Then send us a PR into `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
2020-10-25 09:50:47 +01:00
RUSTDOCFLAGS="--cfg docsrs" cargo doc --open --all-features
2020-04-19 17:43:12 +02:00
# Using nightly rustfmt
cargo +nightly 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.