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 brief contributor guidelines to docs/README.md and/or docs/contributing.md #314

Open
jhkrug opened this issue Sep 19, 2023 · 0 comments
Assignees
Labels
area/documentation Improvements or additions to documentation

Comments

@jhkrug
Copy link
Contributor

jhkrug commented Sep 19, 2023

Things like:

  • We write for a world-wide, international, multilingual audience where English may not be the first language so clarity and simplicity are vital.
  • Be aware of the SUSE and Microsoft style guides we use.
  • Use simple language (for example, use and not leverage). Avoid English idioms implying background cultural understanding. An example: "Details have been glossed over". This is wonderful idiomatic English. But to fully understand it you have to understand that "gloss" is a type of shiny paint, the "over" refers to painting over and hiding or covering the details of some feature. All good stuff, none of which is relevant to understanding and using Epinio. So in this case use, perhaps, "Details are not included here".
  • Use semantic linebreaks, that is, one sentence per line
  • Pointer to a code of conduct for our projects

A few other things maybe, but short and sweet is best.

@jhkrug jhkrug added area/documentation Improvements or additions to documentation kind/epic labels Sep 19, 2023
@jhkrug jhkrug self-assigned this Sep 19, 2023
@jhkrug jhkrug removed the kind/epic label Sep 19, 2023
@jhkrug jhkrug added this to the Outside release-cycle milestone Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
Status: Scheduled
Development

No branches or pull requests

1 participant