Skip to content

docs: add usage examples for generate_guideline_templates.py#414

Merged
plaindocs merged 6 commits into
Safety-Critical-Rust-Consortium:mainfrom
outlookenjoyer:docs/update-template-script-usage
Jul 20, 2026
Merged

docs: add usage examples for generate_guideline_templates.py#414
plaindocs merged 6 commits into
Safety-Critical-Rust-Consortium:mainfrom
outlookenjoyer:docs/update-template-script-usage

Conversation

@outlookenjoyer

Copy link
Copy Markdown
Contributor

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

netlify Bot commented Feb 21, 2026

Copy link
Copy Markdown

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

@plaindocs plaindocs left a comment

Copy link
Copy Markdown
Collaborator

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
Copy Markdown
Contributor 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?

@plaindocs plaindocs left a comment

Copy link
Copy Markdown
Collaborator

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

Comment thread CONTRIBUTING.md Outdated
@outlookenjoyer

Copy link
Copy Markdown
Contributor Author

Hello @plaindocs! Are there any other suggestions or do you have some kind of queue for merge requests?

@netlify

netlify Bot commented Jul 20, 2026

Copy link
Copy Markdown

Deploy Preview for scrc-coding-guidelines ready!

Name Link
🔨 Latest commit e73376e
🔍 Latest deploy log https://app.netlify.com/projects/scrc-coding-guidelines/deploys/6a5ddee7c970d40008c2aba6
😎 Deploy Preview https://deploy-preview-414--scrc-coding-guidelines.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@plaindocs

Copy link
Copy Markdown
Collaborator

I'm so sorry @outlookenjoyer I missed the notification here. I'll try to get this merged.

@plaindocs
plaindocs added this pull request to the merge queue Jul 20, 2026
Merged via the queue into Safety-Critical-Rust-Consortium:main with commit 05e7794 Jul 20, 2026
14 checks passed
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