Skip to content

Commit 98e8187

Browse files
Merge remote-tracking branch 'upstream/main' into fix-387-make-py-uv-lock
2 parents 7e47132 + 05e7794 commit 98e8187

2 files changed

Lines changed: 15778 additions & 15497 deletions

File tree

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,41 @@ As the contributor of the coding guideline and opener of the issue, you'll respo
102102

103103
Once the coding guideline contents have passed review, a subcommittee member with `write` access will approve the pull request, and put it on the merge queue.
104104

105+
### Writing a guideline locally (less typical, not recommended)
106+
107+
We recommend the issue-based workflow above. If you need to work locally, expand the section below.
108+
109+
<details>
110+
<summary>Local authoring steps</summary>
111+
112+
While it is possible to create guidelines locally, we encourage contributors to make use of the process described above since it handles some of the fiddly details for you as a guideline writer.
113+
114+
### Guideline template
115+
116+
Use `./generate_guideline_templates.py` to generate a guideline template with properly randomized IDs. You'll need to `uv` to install the dependencies.
117+
118+
To see all available options, run:
119+
120+
```bash
121+
./generate_guideline_templates.py --help
122+
```
123+
124+
Here are a few examples of how to generate templates:
125+
126+
- Generate a standard template (1 compliant and 1 non-compliant example):
127+
```bash
128+
./generate_guideline_templates.py
129+
```
130+
131+
- Generate a template with multiple examples and a bibliography:
132+
```bash
133+
./generate_guideline_templates.py --non-compliant 2 --compliant 3 --bibliography --bib-entries 2
134+
```
135+
136+
You can then copy and paste this guideline from the command line into the correct chapter.
137+
138+
</details>
139+
105140
### Licenses
106141

107142
There is no Contributor License Agreement to sign to contribute this project.

0 commit comments

Comments
 (0)