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 messaging style to the Zarf style guide and update english.go accordingly #1712

Open
7 tasks
Racer159 opened this issue May 16, 2023 · 0 comments
Open
7 tasks
Labels
tech-debt 💳 Debt that the team has charged and needs to repay

Comments

@Racer159
Copy link
Contributor

Racer159 commented May 16, 2023

Describe what should be investigated or refactored

We should include guidance for Zarf messaging in our style-guide as well as our docs pages. There are certain things we would want to call out like:

  • New messages should go into a lang file such as english.go.
  • Messages should conform to the following:
    • Descriptive name with comment above const block for appropriate go package.
    • If the message is an error message it must have Err in the name, start with a lowercase word and not end in a period if chained to another error (i.e. ends in %s)
    • If the message is an fatal message it must have Fatal in the name, start with an uppercase word and not end in a period if chained to an error (i.e. ends in %s)
    • Regular messages and descriptions should end with punctuation
    • Examples should be contained in parenthesis after the period ending the description

Links to any relevant code

https://github.com/defenseunicorns/zarf/blob/main/docs/12-contribute-to-zarf/4-style-guide.md
https://github.com/defenseunicorns/zarf/blob/main/src/config/lang/english.go

Additional context

@Noxsios mentioned this in a comment here: #1710 (comment)

@Racer159 Racer159 added the tech-debt 💳 Debt that the team has charged and needs to repay label May 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tech-debt 💳 Debt that the team has charged and needs to repay
Projects
None yet
Development

No branches or pull requests

1 participant