Skip to content
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,41 @@ As the contributor of the coding guideline and opener of the issue, you'll respo

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.

### Writing a guideline locally (less typical, not recommended)

We recommend the issue-based workflow above. If you need to work locally, expand the section below.

<details>
<summary>Local authoring steps</summary>

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.

### Guideline template

We have a script `./generate_guideline_templates.py` which assumes you're using `uv` that can be run to generate the template for a guideline with properly randomized IDs.
Comment thread
plaindocs marked this conversation as resolved.
Outdated

To see all available options, run:

```bash
./generate_guideline_templates.py --help
```

Here are a few examples of how to generate templates:

- Generate a standard template (1 compliant and 1 non-compliant example):
```bash
./generate_guideline_templates.py
```

- Generate a template with multiple examples and a bibliography:
```bash
./generate_guideline_templates.py --non-compliant 2 --compliant 3 --bibliography --bib-entries 2
```

You can then copy and paste this guideline from the command line into the correct chapter.

</details>

### Licenses

There is no Contributor License Agreement to sign to contribute this project.
Expand Down
Loading