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

A style guide for the README and the update log #1139

Closed
niklashigi opened this issue Mar 6, 2018 · 2 comments
Closed

A style guide for the README and the update log #1139

niklashigi opened this issue Mar 6, 2018 · 2 comments
Labels
meta Related to Refined GitHub itself

Comments

@niklashigi
Copy link
Contributor

niklashigi commented Mar 6, 2018

Both the README and the new update log contain stylistic inconsistencies. They make the text harder to read and make Refined GitHub look less polished. That's why I wrote a little style guide:

Formatting

  • Keys should be written in lower case.
    • shift instead of Shift.
  • Keys of key combos are only separated by a space.
    • g t instead of g+t.
  • Mouse buttons ("clicks") are treated as keys.
    • alt click instead of alt click.
  • Labels (of buttons, tabs, links, ...) are highlighted using backticks.
    • Button instead of 'Button' or "Button".

Wording

  • Feature bullet points are sentences that start with an imaginary Refined GitHub allows you to ....
    • Toggle files instead of The ability to toggle files or Let's you toggle files.
@fregante fregante added the meta Related to Refined GitHub itself label Mar 6, 2018
@fregante
Copy link
Member

fregante commented Mar 6, 2018

Excellent! Yes please :)

@fregante fregante changed the title Meta: A style guide for the README and the update log A style guide for the README and the update log Mar 6, 2018
@hkdobrev
Copy link
Contributor

hkdobrev commented Mar 6, 2018

Yes to everything in the issue description! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Related to Refined GitHub itself
Development

No branches or pull requests

3 participants