docs: add usage examples for generate_guideline_templates.py#414
docs: add usage examples for generate_guideline_templates.py#414outlookenjoyer wants to merge 5 commits intorustfoundation:mainfrom
Conversation
❌ Deploy Preview for scrc-coding-guidelines failed.
|
plaindocs
left a comment
There was a problem hiding this comment.
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.
|
@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? |
plaindocs
left a comment
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
Done! Also merged main to branch
Closes #407
Added usage instructions and examples to the "Writing a guideline locally" section in
CONTRIBUTING.md.This includes:
--helpcommandThis should make it much easier for new contributors to use the script without needing to read the source code