Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PR template to OGE #311

Closed
1 task
grgmiller opened this issue Nov 21, 2023 · 0 comments · Fixed by #312
Closed
1 task

Add PR template to OGE #311

grgmiller opened this issue Nov 21, 2023 · 0 comments · Fixed by #312
Assignees
Labels
code hygene code readability and structure documentation Improvements or additions to documentation

Comments

@grgmiller
Copy link
Collaborator

Add a PR template to help guide PRs moving forward.

Example that should be improved on:

Summary

A summary of this PR in a couple sentences

Where to look

What files were changed?

Update details

Document in more depth the changes being made

Screenshots

A couple screenshots of the changes/data if relevant.

Testing / Validation

What testing was done, this can be unit tests, manual testing, etc.

Linear ticket

(required for internal Singularity tracking)

Concerns

Anything you'd like to point out that the reviewers should pay special attention to

Next steps / Not addressed here

if relevant, add a couple bullet points on follow-on work to this PR or issues that are not addressed here.

Checklist

  • Update the documentation to reflect changes made in this PR
@grgmiller grgmiller added documentation Improvements or additions to documentation code hygene code readability and structure labels Nov 21, 2023
@grgmiller grgmiller added this to the 2022 Data Release milestone Nov 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code hygene code readability and structure documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants