From 407c493ca84975b7dc133924da8e173dbe13961d Mon Sep 17 00:00:00 2001 From: Fiiranek Date: Mon, 13 Jan 2025 10:54:15 +0100 Subject: [PATCH 1/4] Add `sncast` guidelines to `CONTRIBUTING.md` --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c66883311..eb13ebe68a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,3 +40,15 @@ Creating very large pull requests may significantly increase review time or even At this time, we will not be accepting contributions that only fix spelling or grammar errors in documentation, code or elsewhere. + +### `sncast` Guidelines + +#### Command outputs + +Please follow these rules when creating outputs for `sncast`: + +- Use an imperative tone +- Keep your message concise and to the point +- When displaying config, use `key: value` format +- If the executed command has a natural successor-command, display it as hint in the output +- Use colored text when displaying fees, addresses and hashes From f6b8d1b75a3ee07fbb94081dda59bffc8e9769b4 Mon Sep 17 00:00:00 2001 From: Fiiranek Date: Fri, 17 Jan 2025 16:34:51 +0100 Subject: [PATCH 2/4] Update heading --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb13ebe68a..291897467d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,7 @@ elsewhere. ### `sncast` Guidelines -#### Command outputs +#### Command Outputs Please follow these rules when creating outputs for `sncast`: From a70593c1ea931f53537643bee030fa6ad6d26ae5 Mon Sep 17 00:00:00 2001 From: Fiiranek Date: Fri, 17 Jan 2025 16:36:59 +0100 Subject: [PATCH 3/4] Update successor command point description --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 291897467d..66340d05fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,5 +50,5 @@ Please follow these rules when creating outputs for `sncast`: - Use an imperative tone - Keep your message concise and to the point - When displaying config, use `key: value` format -- If the executed command has a natural successor-command, display it as hint in the output +- If the executed command has a natural successor-command, display it as hint in the output. For example, the output of `declare` command should include a hint to use `deploy` command next. - Use colored text when displaying fees, addresses and hashes From 7b478a6429dae346040478427b58d950b0cfc8c9 Mon Sep 17 00:00:00 2001 From: Fiiranek Date: Fri, 17 Jan 2025 17:09:20 +0100 Subject: [PATCH 4/4] Mention todo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 66340d05fd..39f169bd7d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,4 +51,4 @@ Please follow these rules when creating outputs for `sncast`: - Keep your message concise and to the point - When displaying config, use `key: value` format - If the executed command has a natural successor-command, display it as hint in the output. For example, the output of `declare` command should include a hint to use `deploy` command next. -- Use colored text when displaying fees, addresses and hashes +