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

docs: Add developer release checklist Issue template #1493

Merged
merged 16 commits into from
Jun 21, 2021

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Jun 21, 2021

Description

Resolves #1319

Add a developer release checklist Issue Template to make sure that steps don't get missed during the release and to formalize the release so that any member of the developer team can do it.

Restrict the issue template to project maintainers only. c.f. https://github.com/pypa/pip/blob/e6414d6db6db37951988f6f2b11ec530ed0b191d/.github/ISSUE_TEMPLATE/~good-first-issue.md for an example.

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Add a developer release checklist GitHub Issue template
   - Restrict the Issue template to be usable by project maintainers only
* Add a section to the development docs mentioning the Issue template

@matthewfeickert matthewfeickert added the docs Documentation related label Jun 21, 2021
@matthewfeickert matthewfeickert self-assigned this Jun 21, 2021
@codecov
Copy link

codecov bot commented Jun 21, 2021

Codecov Report

Merging #1493 (018666e) into master (302af0b) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1493   +/-   ##
=======================================
  Coverage   97.65%   97.65%           
=======================================
  Files          63       63           
  Lines        4006     4006           
  Branches      565      565           
=======================================
  Hits         3912     3912           
  Misses         55       55           
  Partials       39       39           
Flag Coverage Δ
contrib 25.51% <ø> (ø)
unittests 97.42% <ø> (ø)

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


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 302af0b...018666e. Read the comment docs.

@matthewfeickert
Copy link
Member Author

matthewfeickert commented Jun 21, 2021

Copy link
Contributor

@kratsg kratsg left a comment

Choose a reason for hiding this comment

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

Shouldn't we add an ISSUE_TEMPLATE for release checklist instead? I'm not sure it needs to be added to the docs explicitly but...

@matthewfeickert
Copy link
Member Author

Shouldn't we add an ISSUE_TEMPLATE for release checklist instead? I'm not sure it needs to be added to the docs explicitly but...

Yeah, that's a much better idea. I originally had this as part of a PR comment, but then changed to an Issue. I'll fix this up. 👍

@matthewfeickert matthewfeickert changed the title docs: Add developer release checklist docs: Add developer release checklist Issue template Jun 21, 2021
@matthewfeickert
Copy link
Member Author

@matthewfeickert matthewfeickert requested a review from kratsg June 21, 2021 17:52
@matthewfeickert matthewfeickert force-pushed the docs/add-developer-release-checklist branch from 36189e3 to 018666e Compare June 21, 2021 20:28
@matthewfeickert matthewfeickert merged commit 07fa272 into master Jun 21, 2021
@matthewfeickert matthewfeickert deleted the docs/add-developer-release-checklist branch June 21, 2021 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a developer release checklist system
2 participants