This is an automated email from the ASF dual-hosted git repository. villebro pushed a commit to branch 1.0 in repository https://gitbox.apache.org/repos/asf/superset.git
commit ca0c07722e7b44e6f3b5982f5d3ae48b4ea24ed3 Author: Michael S. Molina <[email protected]> AuthorDate: Fri Jan 22 20:47:55 2021 -0300 chore: add capitalization guidelines to CONTRIBUTING.md (#12685) --- CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b0670eb..280a212 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) @@ -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.
