New text style rules #166
pklaschka
announced in
Announcements
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
We use the
vale
linter in our project from now on. Vale enforces some new style rules. The most important style rule is that you shouldn't write in the first person. Instead, either write in second person ("In this tutorial, you learn how you can write your first own widget" or as a command: "Add a button") or third person ("This creates a button that, when clicked, triggers theonPress
event.").You can find more information about Vale at https://docs.errata.ai/vale/install.
With a few exceptions (like casing in headings and after colons), we follow the Google developer documentation style guide.
Beta Was this translation helpful? Give feedback.
All reactions