Skip to content

Proof of concept for guideline references#422

Draft
plaindocs wants to merge 2 commits into
mainfrom
needs-references
Draft

Proof of concept for guideline references#422
plaindocs wants to merge 2 commits into
mainfrom
needs-references

Conversation

@plaindocs

@plaindocs plaindocs commented Mar 3, 2026

Copy link
Copy Markdown
Collaborator

Enable referencing external guidelines such as MISRA C as described in #147.

  1. Edit conf.py to set up meta data for guidelines
  2. Add misra field to test guideline
  3. Set up filtered list in Standard Matrices appendix

-> standards matrix page showing the only Guideline with misra != ""

Assumptions:

  • manual entry of misra field

To make this useful:

  • Decided on required fields:
    • Rule (string) and URL for both MISRA C and CERT-C?
    • Is manual entry sufficient?
  • Decide on output for standards page

@netlify

netlify Bot commented Mar 3, 2026

Copy link
Copy Markdown

Deploy Preview for scrc-coding-guidelines ready!

Name Link
🔨 Latest commit 722005d
🔍 Latest deploy log https://app.netlify.com/projects/scrc-coding-guidelines/deploys/69a6eda71520120008a790f2
😎 Deploy Preview https://deploy-preview-422--scrc-coding-guidelines.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@sei-dsvoboda

Copy link
Copy Markdown
Collaborator

@guidelines-bot /r? producers

@github-actions
github-actions Bot requested a review from PLeVasseur March 31, 2026 17:17
@github-actions

Copy link
Copy Markdown
Contributor

👋 Hey @PLeVasseur! You've been assigned to review this coding guideline PR.

Your Role as Reviewer

As outlined in our contribution guide, please:

  1. Begin your review within 14 days
  2. Provide constructive feedback on the guideline content, examples, and formatting
  3. Iterate with @plaindocs - they may update the PR based on your feedback
  4. When the guideline is ready, approve and add to the merge queue

Review Checklist

  • Guideline title is clear and follows conventions
  • Amplification section expands on the title appropriately
  • Rationale explains the "why" effectively
  • Non-compliant example(s) clearly show the problem
  • Compliant example(s) clearly show the solution
  • Code examples compile (check the CI results)
  • FLS paragraph ID is correct

Bot Commands

If you need to pass this review:

  • @guidelines-bot /pass [reason] - Pass just this PR to the next reviewer
  • @guidelines-bot /away YYYY-MM-DD [reason] - Step away from the queue until a date
  • @guidelines-bot /release [@username] [reason] - Release assignment (yours or someone else's with triage+ permission)

To assign someone else:

  • @guidelines-bot /r? @username - Assign a specific reviewer
  • @guidelines-bot /r? producers - Request the next reviewer from the queue

Other commands:

  • @guidelines-bot /claim - Claim this review for yourself
  • @guidelines-bot /rectify - Reconcile this issue/PR review state from GitHub
  • @guidelines-bot /label +label-name - Add a label
  • @guidelines-bot /label -label-name - Remove a label
  • @guidelines-bot /queue - Show reviewer queue
  • @guidelines-bot /commands - Show all available commands

@github-actions

Copy link
Copy Markdown
Contributor

@PLeVasseur (next in queue) has been assigned as reviewer.

@github-actions github-actions Bot added the status: awaiting reviewer response Reviewer-bot is waiting on reviewer freshness or current-head review label Mar 31, 2026
@github-actions
github-actions Bot removed the request for review from PLeVasseur March 31, 2026 17:17
@github-actions

Copy link
Copy Markdown
Contributor

@jmqd is designated as reviewer by queue rotation, but GitHub could not add them to PR Reviewers automatically (API 422). A triage+ approver may still be required before merge queue.

@github-actions

Copy link
Copy Markdown
Contributor

@jmqd remains designated as reviewer in bot state (previously: @PLeVasseur). GitHub reviewer assignment could not be completed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: awaiting reviewer response Reviewer-bot is waiting on reviewer freshness or current-head review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants