Skip to content

Commit 5306b43

Browse files
Add sncast guidelines to CONTRIBUTING.md (#2843)
<!-- Reference any GitHub issues resolved by this PR --> Closes #2604 ## Introduced changes Add `sncast` contribution guidelines ## Checklist <!-- Make sure all of these are complete --> - [x] Linked relevant issue - [x] Updated relevant documentation - [x] Added relevant tests - [x] Performed self-review of the code - [x] Added changes to `CHANGELOG.md`
1 parent 8ce451e commit 5306b43

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,15 @@ Creating very large pull requests may significantly increase review time or even
4040

4141
At this time, we will not be accepting contributions that only fix spelling or grammar errors in documentation, code or
4242
elsewhere.
43+
44+
### `sncast` Guidelines
45+
46+
#### Command Outputs
47+
48+
Please follow these rules when creating outputs for `sncast`:
49+
50+
- Use an imperative tone
51+
- Keep your message concise and to the point
52+
- When displaying config, use `key: value` format
53+
- 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.
54+
<!-- TODO(#2859): Add bullet point about colors used for text when displaying fees, addresses and hashes -->

0 commit comments

Comments
 (0)