├── .github
└── PULL_REQUEST_TEMPLATE.md
├── CONTRIBUTING.md
├── LICENSE
└── README.md
/.github/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
1 | ## Summary
2 |
3 | Proposed changes:
4 |
5 | * ..
6 | * ..
7 |
8 | Resolves # .
9 |
10 | ## Checklist
11 |
12 | * [ ] The changes only affect or contain one style guide rule or section.
13 | * [ ] The changes are in [style guide format](/CONTRIBUTING.md#format).
14 | * [ ] The new style guide section has an entry in the [Table of Contents](/README.md#table-of-contents) (only if changes introduce new section).
15 | * [ ] The changes can be merged into the target branch without conflicts.
16 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | For new additions or changes to the guide, create a branch and submit a Pull Request.
4 | Only add/change 1 style guide rule per Pull Request.
5 | The Pull Request serves as a place to discuss and refine the additions/changes.
6 |
7 | ## Format
8 |
9 | Use [Github Flavoured Markdown](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown).
10 |
11 | Each rule should have the following format:
12 |
13 | ```markdown
14 | ## Rule name
15 | Short summary of the rule to provide context.
16 |
17 | ### Why?
18 | * list
19 | * of
20 | * benefits
21 |
22 | ### How?
23 | Instructions with code examples.
24 | ```
25 |
26 |
27 | ### Rule name
28 |
29 | Use short and descriptive rule names as 2nd level heading:
30 |
31 | ```markdown
32 | ## Avoid `.ready()`
33 | ```
34 |
35 | ### Summary
36 |
37 | Put a short summary directly after the rule name to provide context. When referencing jQuery API methods, link them to jQuery's docs:
38 |
39 | ```markdown
40 | jQuery's [`.ready()`](https://api.jquery.com/ready/) ensures your script is not executed before the DOM is ready. [...]
41 | ```
42 |
43 | ### The *Why?*
44 |
45 | Describe why the rule exists. What purpose does it serve? Bullet lists are often most effective:
46 |
47 | ```markdown
48 | ### Why?
49 |
50 | * Using `.ready()` means scripts have been loaded too early. Therefore defer loading instead.
51 | * Script loading blocks page rendering. Therefore script loading should be defered.
52 | ```
53 |
54 | ### The *How?*
55 |
56 | Describe how (and how not) to apply the rule:
57 |
58 | ```markdown
59 | ### How?
60 |
61 | Defer script loading by placing scripts just before the closing ` ` tag or using the [`defer` attribute](https://developer.mozilla.org/en/docs/Web/HTML/Element/script#attr-defer):
62 | ```
63 |
64 | ### Code snippets
65 |
66 | When using code snippets:
67 | * use