Skip to content

Commit 608c656

Browse files
authored
Merge pull request #26 from pryrt/pryrt-style-guide
Add simple Style Guide to CONTRIBUTION.md
2 parents d5a5099 + 765184f commit 608c656

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTION.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,15 @@ Your pull requests are welcome; however, they may not be accepted for various re
1010

1111
1. Respect Notepad++ User Manuel style.
1212
2. Create a new branch for each PR.
13+
14+
## Style Guide
15+
16+
1. First and foremost, when editing, keep it similar to what's already in that document.
17+
18+
2. When referencing a menu item, like **File > Open**, make it bold, and use > as the separator-character between different levels. <!-- This follows Microsoft documentation style for the separator character, so will make it more familiar to Windows users. -->
19+
20+
3. When referencing a setting in a dialog box, make it bold. Examples:
21+
* On the **Settings > Preferences > Backup** page, please enable **☑ Remember Current Session For Next Launch**"
22+
* Use the checkbox **Search > Find > Search Mode: ☑ Regular Expression** to enable regular expressions in your search
23+
24+
4. For text that you want to indicate as user-entered (such as regular expressions or values entered into dialog box prompts), and for filenames and directories, use backticks to set the `monospaced / code` formatting.

0 commit comments

Comments
 (0)