8000 Organize checklist in PR template by ianhi · Pull Request #21582 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Organize checklist in PR template #21582

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Nov 10, 2021
Merged

Organize checklist in PR template #21582

merged 1 commit into from
Nov 10, 2021

Conversation

ianhi
Copy link
Contributor
@ianhi ianhi commented Nov 10, 2021

PR Summary

Previous the checklist was not ordered in a meaningful way. I think this makes it easier to fill out (and to parse as a reader). I also combined the two flake8 items into one as the second was a superset of the first.

New PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

Old PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@ianhi
Organize checklist in PR template
df41441 
Group logical options together and consolidate the two flake8 items.
@QuLogic QuLogic added this to the v3.6.0 milestone Nov 10, 2021
@QuLogic QuLogic merged commit 89f57a2 into matplotlib:main Nov 10, 2021
@ianhi ianhi deleted the patch-3 branch November 10, 2021 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuLogic QuLogic QuLogic approved these changes

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.6.0
Development

Successfully merging this pull request may close these issues.
3 participants
@ianhi @QuLogic @timhoffm
0