Skip to content

Add a new pull request template - #309

Open
ETSells wants to merge 3 commits into
mainfrom
ES/new-pr-template
Open

Add a new pull request template#309
ETSells wants to merge 3 commits into
mainfrom
ES/new-pr-template

Conversation

@ETSells

@ETSells ETSells commented Aug 8, 2026

Copy link
Copy Markdown
Member

Description

The template in question is being used for this PR, and the templates should be cloned to other firmware repos when merged. The remaining fields will be unmodified for evaluation.

Issue Link

Please provide a link to the issue (e.g. "Closes #1").

Also, if this PR is one of multiple for this issue, link the parent if this is a child OR link
the children if this is the parent. Do not use "closes" keywords on child PRs, only use them on
the parent.

Testing

  • Passes existing automated tests
  • Automated tests modified
  • Manual test performed

Include any relevant test artifacts here.

AI Disclosure (Required)

  • Was an AI agent used to synthesize a significant portion of the submitted code?
  • Do you understand that you are responsible for your contributions, regardless of whether they are generated or hand-written?

Please consider disclosing the specific tools you used (this part is optional):

  • Model: <Model (i.e. ChatGPT 5.6 Sol)>
    • Thinking Level (if applicable):
    • Context Size (if applicable):
  • Harness: <Harness (i.e. GitHub Copilot)>

Other

Leave any additional notes here

Reviewer Checklist

Standards

  • Follows FCF Architectural Standards
  • Follows SDR Coding Standards
  • Code complexity/function Size is minimized
  • Code is testable
  • Code is readable and commented properly
  • License terms are respected

Accuracy

  • Code implements the correct requirement (a.k.a. does the right thing)
  • Code is logically correct (a.k.a. does the thing right)

Error Handling

  • Potentially unsafe functions return a status code
  • Error returns properly handled
  • Fail-fast errors are only thrown when unsafe to continue software execution
  • Debug errors are thrown for exceptions where execution should still continue (to be noticed during development)

Memory

  • Stack allocated memory is scoped correctly
  • Heap allocated memory is not used
  • Statically/Globally allocated memory is minimized except when necessary
  • Pointers are used correctly
  • Concurrent access has been considered (especially by/from interrupt service routines)

Performance

  • Rate limiters are respected
  • Busy waiting is avoided in performance sensitive code
  • "Delay" calls are not used in performance sensitive code
  • If performance is negatively impacted, a justification is provided and the impact is quantified

@ETSells
ETSells requested a review from NArmistead August 8, 2026 21:02
@NArmistead

Copy link
Copy Markdown
Contributor

Should we ask about the scope of the usage?

@ETSells

ETSells commented Aug 11, 2026

Copy link
Copy Markdown
Member Author

sure, willfix

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.

2 participants