Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
moshloop authored Feb 28, 2024
1 parent 34e7f6d commit addc6b5
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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**

Expand All @@ -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.

0 comments on commit addc6b5

Please sign in to comment.