Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sncast guidelines to CONTRIBUTING.md #2843

Merged
merged 8 commits into from
Jan 20, 2025
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
franciszekjob marked this conversation as resolved.
Show resolved Hide resolved

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
franciszekjob marked this conversation as resolved.
Show resolved Hide resolved
- Use colored text when displaying fees, addresses and hashes
franciszekjob marked this conversation as resolved.
Show resolved Hide resolved
Loading