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 issue templates #58

Merged
merged 1 commit into from
Oct 7, 2024
Merged

add issue templates #58

merged 1 commit into from
Oct 7, 2024

Conversation

Bai-Li-NOAA
Copy link
Collaborator

@Bai-Li-NOAA Bai-Li-NOAA commented Oct 7, 2024

@Schiano-NOAA and @sbreitbart-NOAA, This PR adds a few issue templates from FIMS to this repo. The goal is to provide instructions for anyone submitting an issue or PR, as well as for those reviewing pull requests. Please let me know if any of the templates or checklists seem excessive for this repo.

  • add bug report template
  • add feature request template
  • add question template
  • add pull request template
  • add PR checklist

Copy link
Contributor

github-actions bot commented Oct 7, 2024

Instructions for code reviewer

Hello reviewer, thanks for taking the time to review this PR!

  • Please use this checklist during your review, checking off items that you have verified are complete!
  • For PRs that don't make changes to code (e.g., changes to README.md or Github actions workflows), feel free to skip over items on the checklist that are not relevant. Remember it is still important to do a thorough review.
  • Then, comment on the pull request with your review indicating where you have questions or changes need to be made before merging.
  • Remember to review every line of code you’ve been asked to review, look at the context, make sure you’re improving code health, and compliment developers on good things that they do.
  • PR reviews are a great way to learn, so feel free to share your tips and tricks. However, for optional changes (i.e., not required for merging), please include nit: (for nitpicking) before making the suggestion. For example, nit: I prefer using a data.frame() instead of a matrix because...
  • Engage with the developer when they respond to comments and check off additional boxes as they become complete so the PR can be merged in when all the tasks are fulfilled. Make it clear when this has been reached by commenting on the PR with something like This PR is now ready to be merged, no changes needed.

Checklist

  • The PR is requested to be merged into the appropriate branch (typically main)
  • The code is well-designed.
  • The functionality is good for the users of the code.
  • Any User Interface changes are sensible and look good.
  • The code isn’t more complex than it needs to be.
  • Code coverage remains high, indicating the new code is tested.
  • The developer used clear names for everything.
  • Comments are clear and useful, and mostly explain why instead of what.
  • Code is appropriately documented (doxygen and roxygen).

- add bug report template
- add feature request template
- add question template
- add pull request tempate
- add PR checklist
@Bai-Li-NOAA Bai-Li-NOAA marked this pull request as ready for review October 7, 2024 15:13
Copy link
Collaborator

@sbreitbart-NOAA sbreitbart-NOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is now ready to be merged, no changes needed.

@Bai-Li-NOAA Bai-Li-NOAA merged commit 0bd1793 into main Oct 7, 2024
10 checks passed
@sbreitbart-NOAA sbreitbart-NOAA deleted the add-issue-templates branch December 10, 2024 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants