Skip to content

docs: add usage examples for generate_guideline_templates.py#414

Open
outlookenjoyer wants to merge 5 commits intorustfoundation:mainfrom
outlookenjoyer:docs/update-template-script-usage
Open

docs: add usage examples for generate_guideline_templates.py#414
outlookenjoyer wants to merge 5 commits intorustfoundation:mainfrom
outlookenjoyer:docs/update-template-script-usage

Conversation

@outlookenjoyer
Copy link

Closes #407

Added usage instructions and examples to the "Writing a guideline locally" section in CONTRIBUTING.md.

This includes:

  • How to run the --help command
  • Examples of generating templates with specific flags (e.g., configuring the number of compliant/non-compliant examples and adding bibliographies)
  • An example of generating multiple templates at once

This should make it much easier for new contributors to use the script without needing to read the source code

@netlify
Copy link

netlify bot commented Feb 21, 2026

Deploy Preview for scrc-coding-guidelines failed.

Name Link
🔨 Latest commit 2236e14
🔍 Latest deploy log https://app.netlify.com/projects/scrc-coding-guidelines/deploys/69b187dd98b3db00079d907d

Copy link
Collaborator

@plaindocs plaindocs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good.

I've actually suggested removing the section entirely over in #417 if we really don't want people generating guidelines locally, but if we're happy leaving that it's better to have some docs.

I suspect we could remove the multiple templates at once though.

@outlookenjoyer
Copy link
Author

@plaindocs Thanks for the feedback! I've resolved the merge conflicts and kept my changes. I've also removed the section about generating multiple templates as you suggested.

Could you please take another look? If everything is okay now, are you ready to merge this PR?

Copy link
Collaborator

@plaindocs plaindocs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

One simplification suggested.

Hopefully updating from main will fix the FLS error

CONTRIBUTING.md Outdated

### 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
Use `./generate_guideline_templates.py` to generate a guideline template with properly randomized IDs. You'll need to `uv` to install the dependencies.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done! Also merged main to branch

@rustfoundation rustfoundation deleted a comment from github-actions bot Mar 11, 2026
@rustfoundation rustfoundation deleted a comment from github-actions bot Mar 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add some docs about the Local Authoring script

2 participants