Skip to content

Commit cdc57ed

Browse files
committed
Docs: document the branch, title and label conventions for this repository
1 parent 26ff87a commit cdc57ed

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,47 @@ npm run check
2828
local asset references, house style, and that the placeholder domain never
2929
ships.
3030

31+
## Pull requests
32+
33+
One branch per change, off `main`. `main` is protected: it takes no direct push,
34+
and the `build` check has to pass before a merge.
35+
36+
Branch names are `type/short-kebab-description`. Lowercase, hyphens, no
37+
underscores, no ticket numbers, under about 50 characters. The types in use are
38+
`docs` for content, `fix` for a broken page or build, `feat` for a new page or
39+
component, and `chore` for maintenance.
40+
41+
Pull request titles are `Type: short description`, lowercase after the colon,
42+
matching the branch type. The title becomes the squash commit, so it has to
43+
describe the change on its own.
44+
45+
Write the title and body for someone reading the repository later. Describe the
46+
diff, not how it was arrived at. No references to a conversation, a screenshot,
47+
a previous attempt or a review comment.
48+
49+
`.github/PULL_REQUEST_TEMPLATE.md` fills in when the pull request opens.
50+
Complete every section and set the checklist boxes.
51+
52+
Pick one label, the most specific that fits. Add a second only when the change
53+
genuinely crosses two categories.
54+
55+
| Label | For |
56+
| --- | --- |
57+
| `documentation` | Documentation pages and their structure |
58+
| `content` | Wording, structure, new pages |
59+
| `widget-preview` | Widget previews and their stub data |
60+
| `ui/ux` | Layout, styling and accessibility |
61+
| `accessibility` | A barrier affecting people with disabilities |
62+
| `bug` | Something on the site is broken |
63+
| `security` | A security fix |
64+
| `dependencies` | A dependency update |
65+
| `github_actions` | Workflow and CI changes |
66+
| `javascript` | Build scripts and page logic |
67+
| `refractor` | Cleanup with no behaviour change |
68+
69+
This repository has no `CHANGELOG.md`. The site publishes on merge, and the
70+
Changelog page it serves belongs to the application. Nothing here is versioned.
71+
3172
## Where things live
3273

3374
| Path | Holds |

0 commit comments

Comments
 (0)