Skip to content

Commit

Permalink
Bump MSRV to the Rust 1.81 release
Browse files Browse the repository at this point in the history
The home crate now requires 1.81, and we can keep with our N-2 policy
since 1.83 has been out over a month now. Note that the current version
of prettier has tweaked the formatting for the markdown files, but there
is no actual content difference.
  • Loading branch information
elasticdog committed Dec 30, 2024
1 parent 56afe1f commit 7537a99
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 29 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The format is based on [Keep a Changelog][1], and this project adheres to
### Changed

- Relicense project from MIT to Zero Clause BSD (0BSD).
- Bump MSRV to the Rust 1.81 release.

## [0.2.1] - 2023-11-29

Expand Down
34 changes: 17 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# Contributing to spellout

Thank you for your interest in contributing to our [open source][] project! This
document will guide you through the process. To maintain a respectful and welcoming
community, please adhere to the [Code of Conduct][CoC].
document will guide you through the process. To maintain a respectful and
welcoming community, please adhere to the [Code of Conduct][CoC].

[open source]: https://opensource.guide/
[CoC]: CODE_OF_CONDUCT.md

## Getting Started

spellout uses the GitHub [issue tracker][] to manage bugs and feature requests. If
you'd like to work on a specific issue, leave a comment, and we will assign it to
you. For general questions and open-ended conversations, use the dedicated community
[discussions][] space instead.
spellout uses the GitHub [issue tracker][] to manage bugs and feature requests.
If you'd like to work on a specific issue, leave a comment, and we will assign
it to you. For general questions and open-ended conversations, use the dedicated
community [discussions][] space instead.

Please submit contributions through GitHub [pull requests][]. Each PR will be reviewed
by a core contributor (someone with permission to approve patches), and either merged
or provided with feedback for any required changes. _This process applies to all
contributions, including those from core contributors._
Please submit contributions through GitHub [pull requests][]. Each PR will be
reviewed by a core contributor (someone with permission to approve patches), and
either merged or provided with feedback for any required changes. _This process
applies to all contributions, including those from core contributors._

If your intended contribution is complex or requires discussion, open a new
[ideas discussion][] about the change before starting the work. We're more than happy
to mentor contributors and provide guidance or clarification when needed.
[ideas discussion][] about the change before starting the work. We're more than
happy to mentor contributors and provide guidance or clarification when needed.

[issue tracker]: https://github.com/EarthmanMuons/spellout/issues
[discussions]: https://github.com/EarthmanMuons/spellout/discussions
Expand Down Expand Up @@ -53,9 +53,9 @@ When reporting a bug or requesting a feature, please follow these steps:
### Issue Labels

Built-in issue templates will automatically apply some labels, but we also rely
on GitHub's [default labels][] to categorize issues and pull requests further. Familiarize
yourself with these labels to better understand the organization and prioritization
of tasks within the project.
on GitHub's [default labels][] to categorize issues and pull requests further.
Familiarize yourself with these labels to better understand the organization and
prioritization of tasks within the project.

[default labels]:
https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#about-default-labels
Expand Down Expand Up @@ -223,8 +223,8 @@ than adding commits on top, and then force push them to your repository. As you
update your PR and apply changes, mark each conversation as [resolved][].

Once your changes have been discussed and approved, we use GitHub [merge
queues][] to enforce the [not rocket science][] rule of software engineering, ensuring
that tests on the `main` branch always pass.
queues][] to enforce the [not rocket science][] rule of software engineering,
ensuring that tests on the `main` branch always pass.

[resolved]:
https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resolver = "2"
version = "0.2.1"
authors = ["Aaron Bull Schaefer <aaron@elasticdog.com>"]
edition = "2021"
rust-version = "1.75"
rust-version = "1.81"
description = "Convert characters into spelling alphabet code words"
documentation = "https://github.com/EarthmanMuons/spellout/"
readme = "README.md"
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
---

A command-line application for transforming text strings into corresponding code
words based on predefined [spelling alphabets][], like the NATO phonetic alphabet.
These alphabets are designed to enhance verbal clarity, especially when spelling
out words over low-fidelity voice channels.
words based on predefined [spelling alphabets][], like the NATO phonetic
alphabet. These alphabets are designed to enhance verbal clarity, especially
when spelling out words over low-fidelity voice channels.

[spelling alphabets]: https://en.wikipedia.org/wiki/Spelling_alphabet

Expand Down Expand Up @@ -131,8 +131,8 @@ The extracted directory contains:

### Building from Source

After [installing Rust][], to build the binary and install it on your system under
the `~/.cargo/bin/` directory, run the following command:
After [installing Rust][], to build the binary and install it on your system
under the `~/.cargo/bin/` directory, run the following command:

```
cargo install --locked --git https://github.com/EarthmanMuons/spellout/ spellout
Expand Down
1 change: 1 addition & 0 deletions crates/spellabet/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The format is based on [Keep a Changelog][1], and this project adheres to
### Changed

- Relicense project from MIT to Zero Clause BSD (0BSD).
- Bump MSRV to the Rust 1.81 release.

### Changed

Expand Down
10 changes: 5 additions & 5 deletions crates/spellabet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
[![CI status](https://img.shields.io/github/actions/workflow/status/EarthmanMuons/spellout/on-pull-request.yml?event=merge_group&label=ci&logo=github)](https://github.com/EarthmanMuons/spellout/actions?query=event%3Amerge_group)
[![crates.io](https://img.shields.io/crates/v/spellabet)](https://crates.io/crates/spellabet/)
[![docs.rs](https://img.shields.io/docsrs/spellabet)](https://docs.rs/spellabet/0.2.0/spellabet/)
[![MSRV](https://img.shields.io/badge/rust-1.75%2B-blue)](https://doc.rust-lang.org/cargo/reference/manifest.html#the-rust-version-field)
[![MSRV](https://img.shields.io/badge/rust-1.81%2B-blue)](https://doc.rust-lang.org/cargo/reference/manifest.html#the-rust-version-field)

---

A Rust library for transforming text strings into corresponding code words based
on predefined [spelling alphabets][], like the NATO phonetic alphabet. These alphabets
are designed to enhance verbal clarity, especially when spelling out words over low-fidelity
voice channels. This library supports several standard alphabets and allows for customization
to suit specific communication needs.
on predefined [spelling alphabets][], like the NATO phonetic alphabet. These
alphabets are designed to enhance verbal clarity, especially when spelling out
words over low-fidelity voice channels. This library supports several standard
alphabets and allows for customization to suit specific communication needs.

In operation, spellabet preserves the original capitalization of letters by
returning either lowercase or uppercase code words. It similarly converts known
Expand Down
2 changes: 1 addition & 1 deletion xtask/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "xtask"
edition = "2021"
rust-version = "1.75"
rust-version = "1.81"
license = "MIT OR Apache-2.0"
publish = false

Expand Down

0 comments on commit 7537a99

Please sign in to comment.