From addc6b53e3232f08fd99ffb3a1d1ed2ba74c7958 Mon Sep 17 00:00:00 2001 From: Moshe Immerman Date: Wed, 28 Feb 2024 15:24:37 +0200 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4be09cb..04af045b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,17 @@ + +Use the [Google Technical Docs Style Guide](https://developers.google.com/style/) + + +# Tone + +* Use [second-person](https://developers.google.com/style/person) pronouns (you, your) with an [active](https://developers.google.com/style/voice) voice, in the [present](https://developers.google.com/style/tense) tense + # Duplicate 1. Prefer duplication to referencing where possible - it makes it easier for humands and AI to read. -# Styling +# Formatting 1. Use **Menu** → **Submenu** @@ -14,15 +22,14 @@ # Screenshots -1. Use close up screenshots where possible rather than full page screenshot +1. Use Node Screenshots where possible (Or get as close up as possible) * Use Chrome -> Inspect -> Right Click Capture Node Screenshot 2. Never include the browser frame 3. The screenshot should have good quality / realistic data - If necessary modify the html before taking a screenshot -4. Infer the screenshot in the sentance before, e.g. After click on A you will see a modal popup: +4. Infer the screenshot in the sentance before, e.g. In the **Add Health Check modal** you will see # Code blocks 1. Always include the language and a title 2. Prefer to inline comments into the code 3. Comments should always be on the line above, not on the right hand side unless its really short and reads well e.g. `duration: 5m # since start` -4.