Skip to content
New issue

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

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

Already on GitHub? # to your account

Add issue and pull request templates, and detailed contribution checklist #465

Merged
merged 9 commits into from
Apr 19, 2024

Conversation

jfrost-mo
Copy link
Member

@jfrost-mo jfrost-mo commented Apr 2, 2024

Description

Add issue and PR templates to help guide people in creating useful issues. Also adds a detailed contribution checklist to the developer's guide. This should serve as a nice step-by-step guide for someone unfamiliar with the project.

Fixes #252

Contribution checklist

Aim to have all relevant checks ticked off before merging. See the developer's guide for more detail.

  • Documentation has been updated to reflect change.
  • New code has tests, and affected old tests have been updated.
  • All tests and CI checks pass.
  • Added an entry to the top of docs/source/changelog.rst N/A before Add changelog #467
  • Conda lock files have been updated if dependencies changed.
  • Marked the PR as ready to review.

Copy link
Contributor

github-actions bot commented Apr 2, 2024

Coverage

@jfrost-mo jfrost-mo force-pushed the 252_issue_templates branch 3 times, most recently from 0e26e4f to 64a9737 Compare April 2, 2024 10:26
@jfrost-mo jfrost-mo changed the title Update issue templates Add issue and PR templates Apr 2, 2024
@jfrost-mo jfrost-mo added enhancement New feature or request cleanup Non-functional improvement labels Apr 2, 2024
@jfrost-mo jfrost-mo marked this pull request as draft April 2, 2024 11:41
@jfrost-mo jfrost-mo marked this pull request as ready for review April 2, 2024 12:40
@jfrost-mo jfrost-mo self-assigned this Apr 2, 2024
@jfrost-mo jfrost-mo requested review from Sylviabohnenstengel and jwarner8 and removed request for Sylviabohnenstengel April 2, 2024 12:41
@jfrost-mo
Copy link
Member Author

Let me know what you think of the templates. Should they have more structure/guidance? Less?

@jfrost-mo jfrost-mo changed the title Add issue and PR templates Add issue and pull request templates Apr 16, 2024
@jfrost-mo jfrost-mo removed the request for review from jwarner8 April 18, 2024 12:16
@jfrost-mo jfrost-mo changed the title Add issue and pull request templates Add issue and pull request templates, and detailed contribution checklist Apr 18, 2024
@jfrost-mo
Copy link
Member Author

Rendered detailed checklist:
Screenshot 2024-04-18 at 16-28-11 Developer’s Guide - CSET documentation

Copy link
Contributor

@Sylviabohnenstengel Sylviabohnenstengel left a comment

Choose a reason for hiding this comment

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

small changes

@jfrost-mo jfrost-mo merged commit b8d4101 into main Apr 19, 2024
8 checks passed
@jfrost-mo jfrost-mo deleted the 252_issue_templates branch April 19, 2024 06:53
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
cleanup Non-functional improvement enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add GitHub issue and PR templates
2 participants