ENH: Add PR template - Githubissues

richford commented 4 months ago

Proposed changes

This PR adds a PR template that will serve as a starting point for all future PRs. It is intended to be a general purpose PR template for use in ALL ROAR repositories. If it is approved and merged for this repository, I will then add it to all other ROAR repos.

Types of changes

What types of changes does your code introduce? Put an x in the boxes that apply

[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] Documentation Update (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

[x] I have read the guidelines for contributing.
[x] The changes in this PR are as small as they can be. They represent one and only one fix or enhancement.
[x] Linting checks pass with my changes.
[x] Any existing unit tests pass with my changes.
[x] Any existing end-to-end tests pass with my changes.
[ ] I have added tests that prove my fix is effective or that my feature works.
[x] If this PR fixes an existing issue, I have added a unit or end-to-end test that will detect if this issue reoccurs.
[x] I have added JSDoc comments as appropriate.
[x] I have added the necessary documentation to the roar-docs repository.

Justification of missing checklist items

This PR does not warrant adding any tests.

github-actions[bot] commented 4 months ago

Visit the preview URL for this PR (updated for commit 9208b89):

https://roar-staging--pr628-enh-add-pr-template-mtnr9rvr.web.app

_{(expires Thu, 06 Jun 2024 21:11:32 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 2631e9c58fd0104ecbfddd72a62245ddac467460}

Zio-4 commented 4 months ago

I think we should add a section for images if applicable.

cypress[bot] commented 4 months ago

Passing run #2210 ↗︎

0

26

0

Details:

Tests for PR 628 "ENH: Add PR template" from commit "9208b893473bf4e3c616f2b4d7c...
Project: roar-dashboard-e2e	Commit: `9208b89347`
Status: Passed	Duration: 03:28 💡
Started: May 30, 2024 9:10 PM	Ended: May 30, 2024 9:14 PM

Review all test suite changes for PR #628 ↗︎