Skip to content

docs: add comments in pull request template#1308

Open
wesleyboar wants to merge 1 commit into
mainfrom
docs/pr-template
Open

docs: add comments in pull request template#1308
wesleyboar wants to merge 1 commit into
mainfrom
docs/pr-template

Conversation

@wesleyboar

@wesleyboar wesleyboar commented Jun 2, 2026

Copy link
Copy Markdown
Member

Overview

Add comments to PR template, for new devs.

Note

💡 Ideas:

  1. Should the comments be on one line <-- ... --> instead of three?
    • Easier to delete.
    • Less likely for markdown-noobs to change content in between <!-- and --> but still retain <!-- and -->.
  2. Should headings match DesignSafe-CI's?

Related & Changes

Testing

  1. Open rendering.
  2. Comments are not visible.
  3. Headings are unchanged.

UI

See rendering and raw markdown.

Mimics changes to DesignSafe-CI/portal#1710. Does not change existing headings.
@wesleyboar wesleyboar marked this pull request as ready for review June 2, 2026 23:47
@codecov

codecov Bot commented Jun 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.08%. Comparing base (fef9bc2) to head (c5cfbbe).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1308   +/-   ##
=======================================
  Coverage   64.08%   64.08%           
=======================================
  Files         461      461           
  Lines       13785    13785           
  Branches     2748     2748           
=======================================
  Hits         8834     8834           
  Misses       4602     4602           
  Partials      349      349           
Flag Coverage Δ
javascript 67.08% <ø> (ø)
unittests 60.91% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

1 participant