Skip to content

Conversation

rcomer
Copy link
Member

@rcomer rcomer commented Feb 12, 2023

PR Summary

We have guidance for adding flags to commit messages to control which CI tasks run. Currently this starts with "If you know your changes do not need to be tested (this is very rare!)..." My instinct on reading this is to think this whole bullet point is not for me, and not bother reading the rest. So I re-ordered to start with the doc-only check, as I think that would be most commonly used, followed by skip circle. Also added some context for when it would be appropriate to use those.

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

@rcomer rcomer changed the title DOC: reorder CI control guidance [ci doc] DOC: reorder CI control guidance Feb 12, 2023
@story645
Copy link
Member

Showing my bias for tables, can this be a table or a bullet akin to a latex description list, so leads w/ the command and then the explanation?

@rcomer
Copy link
Member Author

rcomer commented Feb 12, 2023

@story645 how's this?

@story645 story645 added this to the v3.7-doc milestone Feb 12, 2023
@timhoffm timhoffm merged commit 7f6f8cd into matplotlib:main Feb 12, 2023
@QuLogic QuLogic modified the milestones: v3.7-doc, v3.8.0 Feb 21, 2023
@rcomer rcomer deleted the ci-skip-docs branch March 4, 2023 16:32
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.

4 participants