admin/topgrade
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md to reflect enum Step sort enforcement (#1111)

Browse Source 
* Update CONTRIBUTING.md

* Formatting
This commit is contained in:
Gideon
2025-04-09 04:03:32 +02:00
committed by GitHub
parent 3dc8d31d57
commit 2bf6a2b100
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md
View File

@@ -20,11 +20,11 @@ To add a new `step` to `topgrade`:
```rust ```rust
pub enum Step { pub enum Step {
// Existed steps // Existing steps
// ... // ...
// Your new step here! // Your new step here!
// You may want it to be sorted alphabetically because that looks great:) // Make sure it stays sorted alphabetically because that looks great :)
Xxx, Xxx,
} }
``` ```
@@ -78,7 +78,7 @@ To add a new `step` to `topgrade`:
to separate the steps, for example, for steps that are Linux-only, it goes to separate the steps, for example, for steps that are Linux-only, it goes
like this: like this:
``` ```rust
#[cfg(target_os = "linux")] #[cfg(target_os = "linux")]
{ {
// Xxx is Linux-only // Xxx is Linux-only
@@ -86,7 +86,7 @@ To add a new `step` to `topgrade`:
} }
``` ```
Congrats, you just added a new `step`:) Congrats, you just added a new `step` :)
## Modification to the configuration entries ## Modification to the configuration entries
@@ -129,12 +129,12 @@ $ cargo test
Don't worry about other platforms, we have most of them covered in our CI. Don't worry about other platforms, we have most of them covered in our CI.
## I18n ## I18n
If your PR introduces user-facing messages, we need to ensure they are translated. If your PR introduces user-facing messages, we need to ensure they are translated.
Please add the translations to [`locales/app.yml`][app_yml]. For simple messages Please add the translations to [`locales/app.yml`][app_yml]. For simple messages
without arguments (e.g., "hello world"), we can simply translate them according without arguments (e.g., "hello world"), we can simply translate them according
(Tip: ChatGPT or similar LLMs is good at translation). If a message contains (Tip: ChatGPT or similar LLMs is good at translation). If a message contains
arguments, e.g., "hello <NAME>", please follow this convention: arguments, e.g., "hello <NAME>", please follow this convention:
```yml ```yml