Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (68 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

87 lines (68 loc) · 3.1 KB
Raw

CONTRIBUTING

  • All changes should be based on the current stable version & not pre-release or development builds.
  • Add settings related only to privacy/security. Don’t include changes for usability, appearance, behavior, or other such features.
  • Use ## for sections & #### for subsections. Try to avoid ### unless absolutely necessary. The size difference between ## and #### is much more noticeable when rendered.
    • Unrendered: 
      ## Search

#### Default search engine

#### Search engine suggestions



## Privacy and security

#### Enhanced Tracking Protection

#### Additional protections
    • Rendered:

      Search

      Default search engine

      Search engine suggestions

      Privacy and security

      Enhanced Tracking Protection

      Additional protections

  • Keep blank lines exactly as they are. Add 3 blank lines before a section starts and 1 blank line before a subsection starts. These blank lines help me while navigating and editing the files, even though they don't visually make a difference when rendered. Example: 
    ## Search

#### Default search engine

#### Search engine suggestions



## Privacy and security

#### Enhanced Tracking Protection

#### Additional protections
  • Decide what should be a section vs subsection based on the UI. Sections are usually the first level of clicks/taps, while subsections can vary. Sometimes in the UI, subsections/categories feel forced or are styled in such a way that users may overlook and the settings may already be clear enough to be listed as bullet points. Check the examples below:

    • Firefox Desktop:

      Home and startup

      Firefox Home

      • Stories: Off

      Privacy and security

      Additional protections

      • Tell websites not to sell or share my data: Off

      DNS over HTTPS

      • Advanced settings >
        • Custom
          • Choose provider: NextDNS

      Connection and software security

      • Advanced settings >
        • HTTPS-Only Mode: Enable HTTPS-Only Mode in all windows

    • Brave Browser Mobile:

      Brave shields & privacy

      • Block trackers and ads: Block trackers & ads (Aggressive)
      • Auto-redirect AMP pages: On

      Leo AI

      • Store my conversation history: Off

      New Tab Page

      • Show New Tab Page Ads: Off
      • Show Top Sites: Off
  • Don't use GitHub's [!NOTE] or [!TIP] blocks since they don't support indentation. Use the following custom format instead:
    • Note: 
      > <img src="../icons/ic_note.svg" width="22" align="top"> **Note**
>
> Add the note here
    • Tip: 
      > <img src="../icons/ic_tip.svg" width="22" align="top"> **tip**
>
> Add the tip here