teloxide/CONTRIBUTING.md

Contributing

Note

These contributing instructions might not be fully up-to-date or complete. However, they should be a good starting point.

If you find inaccuracies/missing things, please expand this or contact us.

Reporting bugs, questions, feature requests

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

If you want to ask a question, you can either

• open a new GitHub discussion, or
• write to our Telegram group (ENG, RU).

Code

Style guide

Before writing code, please read our code style.

Git

To change the source code, you need a local copy of it. Fork the master branch of this repository via GitHub and clone your fork locally.

When working on a new thing, create a new branch with git switch -c my-branch-name (or other commands that work with branches). This way, it will be easier to manage when you want to do other things.

When your changes are ready, you can open a new GitHub pull request.

Pull Requests

If your pull request fixes/resolves an existing GitHub issue, please specify so in the PR description. For example:

Fixes #991.

You can learn more about using keywords in issues and pull requests in the GitHub documentation.

If your pull request suggests new functionality or new changes, please explain your point of view and all the necessary details (pros, cons, why you chose the design you chose, your use cases, etc.)

In general, try to make PR title/description as clear as possible, as they are the primary ways of communicating your intent to the reviewer.

Merge conflicts

If your branch has conflicts with master, please resolve them by doing something like this:

# Temporary switch to master branch
git switch master

# Pull changes from the upstream.
# You may need to use something different from "origin",
# depending on how you setup your remotes.
git pull origin master

# Switch back to your feature branch
git switch -

# Move your changes on top of changes in master branch.
git rebase master

# Here you'll need to resolve the conflicts,
# git commands will print some guidance.

# Once conflicts are resolved,
# forcefully push the changes to your fork
git push --force-with-lease

Testing

When you open a PR, it will be tested in the CI. We recommend you test the PR before opening it:

# Formatting (use `-- --check` if you only want to check)
cargo fmt --all

# Build
cargo build --features "full nightly"

# Run linter
cargo clippy --all-targets --features "full nightly"

# Running tests
cargo test --features "full nightly"

# Documentation (use --open if you want to open it in a browser)
# (note the -s, `docs` is an alias to pass some additional flags to `rustdoc`)
cargo docs

Bumping supported TBA version

When you introduce changes that bump suppported Telegram Bot API version (e.g. 6.9 → 7.0), you must:

• Specify your changes in crates/teloxide-core/CHANGELOG.md file
• Change TBA version and it's announce date in api_version: ApiVersion(ver: "7.0", date: "December 29, 2023"), line in head of crates/teloxide-core/schema.ron file
• Change TBA version in (Currently, version … is supported) line in head of crates/teloxide-core/src/lib.rs file
• Change TBA version in Currently, version … of line in head of crates/teloxide/src/lib.rs file
• Change TBA version in …https://img.shields.io/badge/API%20coverage… line in crates/teloxide-core/README.md file
• Change TBA version in …https://img.shields.io/badge/API%20coverage… line in README.md file

@teloxidebot

teloxide uses @teloxidebot as a helper to manage PRs and issues. It is based on triagebot used by rustc developers, which docs can be found here.

We will describe here a few most used @teloxidebot's features, but we still recommend you to read the docs.

PR status tracking

teloxide uses S-* labels (mainly https://github.com/teloxide/teloxide/labels/S-waiting-on-author and https://github.com/teloxide/teloxide/labels/S-waiting-on-review) to track the status of pull requests.

You can change the status with @teloxidebot review and @teloxidebot ready (sets the status to https://github.com/teloxide/teloxide/labels/S-waiting-on-review) or @teloxidebot author (sets the status to https://github.com/teloxide/teloxide/labels/S-waiting-on-author).

Requesting a review from PR's assignee via GitHub UI will also change the status of the PR to waiting on review. Similarly, submitting a review that requests changes will change the status of the PR to waiting on author.

There is also https://github.com/teloxide/teloxide/labels/S-blocked, which can be set with @teloxidebot blocked.

Please note that your PR won't be reviewed unless it's waiting for review :)

Labels

Normally, GitHub only allows privileged users to change labels. @teloxidebot allows anyone to add or remove certain labels with @teloxidebot label +additional_label -removed_label. See more in the documentation.

PR assignment

When a PR is created, @teloxidebot will automatically assign one of the maintainers to it. If you want to override this assignment, use r? @ReviewerUsername.