OpenSource/teloxide
OpenSource/teloxide
1
0
Fork 0
mirror of https://github.com/teloxide/teloxide.git synced 2024-12-22 14:35:36 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1102 from shdwchn10/feature/tba-version

Browse source 
Tidy up documentation regarding the latest supported version of TBA
This commit is contained in:
Waffle Maybe 2024-07-20 18:14:37 +00:00 committed by GitHub
commit cb7284c2e3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 15 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -93,6 +93,17 @@ cargo test --features "full nightly"
cargo docs 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](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](crates/teloxide-core/schema.ron) file
- Change TBA version in `(Currently, version … is supported)` line in head of [crates/teloxide-core/src/lib.rs](crates/teloxide-core/src/lib.rs) file
- Change TBA version in `Currently, version … of` line in head of [crates/teloxide/src/lib.rs](crates/teloxide/src/lib.rs) file
- Change TBA version in `…https://img.shields.io/badge/API%20coverage…` line in [crates/teloxide-core/README.md](crates/teloxide-core/README.md) file
- Change TBA version in `…https://img.shields.io/badge/API%20coverage…` line in [README.md](README.md) file
## @teloxidebot ## @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](https://forge.rust-lang.org/triagebot/index.html). `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](https://forge.rust-lang.org/triagebot/index.html).

2
crates/teloxide-core/src/lib.rs
View file

@ -1,7 +1,7 @@
//! Core part of the [`teloxide`] library. //! Core part of the [`teloxide`] library.
//! //!
//! This library provides tools for making requests to the [Telegram Bot API] //! This library provides tools for making requests to the [Telegram Bot API]
//! (Currently, version `6.6` is supported) with ease. The library is fully //! (Currently, version `6.9` is supported) with ease. The library is fully
//! asynchronous and built using [`tokio`]. //! asynchronous and built using [`tokio`].
//! //!
//!```toml //!```toml

4
crates/teloxide/src/lib.rs
View file

@ -1,6 +1,7 @@
//! A full-featured framework that empowers you to easily build [Telegram bots] //! A full-featured framework that empowers you to easily build [Telegram bots]
//! using [Rust]. It handles all the difficult stuff so you can focus only on //! using [Rust]. It handles all the difficult stuff so you can focus only on
//! your business logic. //! your business logic. Currently, version `6.9` of [Telegram Bot API] is
//! supported.
//! //!
//! For a high-level overview, see [our GitHub repository](https://github.com/teloxide/teloxide). //! For a high-level overview, see [our GitHub repository](https://github.com/teloxide/teloxide).
//! //!
@ -31,6 +32,7 @@
//! </kbd> //! </kbd>
//! </div> //! </div>
//! //!
//! [Telegram Bot API]: https://core.telegram.org/bots/api
//! [Telegram bots]: https://telegram.org/blog/bot-revolution //! [Telegram bots]: https://telegram.org/blog/bot-revolution
//! [`async`/`.await`]: https://rust-lang.github.io/async-book/01_getting_started/01_chapter.html //! [`async`/`.await`]: https://rust-lang.github.io/async-book/01_getting_started/01_chapter.html
//! [Rust]: https://www.rust-lang.org/ //! [Rust]: https://www.rust-lang.org/