Skip to content

Commit

Permalink
chore: add capitalization guidelines to CONTRIBUTING.md (#12685)
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-s-molina authored and villebro committed Jan 25, 2021
1 parent 8d80262 commit ca0c077
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ little bit helps, and credit will always be given.
- [Reviewing](#reviewing)
- [Merging](#merging)
- [Post-merge Responsibility](#post-merge-responsibility)
- [Capitalization Guidelines](#capitalization-guidelines)
- [Managing Issues and PRs](#managing-issues-and-prs)
- [Reporting a Security Vulnerability](#reporting-a-security-vulnerability)
- [Revert Guidelines](#revert-guidelines)
Expand Down Expand Up @@ -247,6 +248,52 @@ Finally, never submit a PR that will put master branch in broken state. If the P
- Project maintainers may contact the PR author if new issues are introduced by the PR.
- Project maintainers may revert your changes if a critical issue is found, such as breaking master branch CI.

## Capitalization Guidelines

### Sentence case

Use sentence-case capitalization for everything in the UI (except these \*\*).

Sentence case is predominantly lowercase. Capitalize only the initial character of the first word, and other words that require capitalization, like:

- Proper nouns. Objects in the product are not considered proper nouns e.g. dashboards, charts, saved queries etc. Proprietary feature names eg. SQL Lab, Preset Manager are considered proper nouns
- Acronyms (e.g. CSS, HTML)
- When referring to **UI labels that are themselves capitalized** from sentence case (e.g. page titles - Dashboards page, Charts page, Saved queries page, etc.)
- User input that is reflected in the UI. E.g. a user-named a dashboard tab

#### Sentence case vs. Title case:

Title case: "A Dog Takes a Walk in Paris"
Sentence case: "A dog takes a walk in Paris"

#### Why sentence case?

- It’s generally accepted as the quickest to read
- It’s the easiest form to distinguish between common and proper nouns

### How to refer to UI elements

When writing about a UI element, use the same capitalization as used in the UI.

For example, if an input field is labeled “Name” then you refer to this as the “Name input field”. Similarly, if a button has the label “Save” in it, then it is correct to refer to the “Save button”.

Where a product page is titled “Settings”, you refer to this in writing as follows:
“Edit your personal information on the Settings page”.

Often a product page will have the same title as the objects it contains. In this case, refer to the page as it appears in the UI, and the objects as common nouns:

- Upload a dashboard on the Dashboards page
- Go to Dashboards
- View dashboard
- View all dashboards
- Upload CSS templates on the CSS templates page
- Queries that you save will appear on the Saved queries page
- Create custom queries in SQL Lab then create dashboards

### \*\*Exceptions to sentence case:

- Input labels, buttons and tabs are all caps

## Managing Issues and PRs

To handle issues and PRs that are coming in, committers read issues/PRs and flag them with labels to categorize and help contributors spot where to take actions, as contributors usually have different expertises.
Expand Down

0 comments on commit ca0c077

Please sign in to comment.