Skip to content
Merged
Changes from 1 commit
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
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,29 @@ While it is possible to create guidelines locally, we encourage contributors to

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
```

- Generate multiple templates at once:
```bash
./generate_guideline_templates.py -n 3
```

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

</details>
Expand Down