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

Style guide/formatting policy #26

Closed
s-makin opened this issue Aug 2, 2023 · 4 comments
Closed

Style guide/formatting policy #26

s-makin opened this issue Aug 2, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation invalid This doesn't seem right

Comments

@s-makin
Copy link
Collaborator

s-makin commented Aug 2, 2023

As per discussion started in this PR - we ought to have a style guide for contributors. Let's use this issue to align on what we want the policies to be, and create the style guide based on that. Starting it off with DV's suggestions from that PR:

  • max line lengths (doesn't have to be 79 characters; we don't live in the 80s)
  • empty new line at end of file
  • no trailing whitespace at end of line
  • two (or more) consecutive empty lines should be avoided (exceptions are okay, if they improve readability)
@dviererbe dviererbe mentioned this issue Sep 21, 2023
@dviererbe
Copy link
Collaborator

  1. What should the usage conventions/restrictions of cards, tabs, dropdowns be?

  2. Does anyone have a good Idea how we can utilize badges and inline icons? I don't want to use them just because we can, but I have the feeling that there is an opportunity to make our documentation more intuitive.

@dviererbe
Copy link
Collaborator

Thought: Maybe we could use the icons for links to indicate if they are external links or cross references.

@s-makin
Copy link
Collaborator Author

s-makin commented Oct 9, 2023

I was just wondering if maybe we should have a roundtable discussion during the sprint to decide what we do and don't want in the policy? Get the whole thing written up and published in one session - wdyt?

@dviererbe
Copy link
Collaborator

I am closing this issue for now as the current strategy is to upstream all styling related changes into the canonical starter-pack/style-guide to have a unified style across all Canonical documentation.

@dviererbe dviererbe added documentation Improvements or additions to documentation invalid This doesn't seem right labels Nov 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation invalid This doesn't seem right
Projects
None yet
Development

No branches or pull requests

2 participants