Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Doc]: Move Automated Tests section to workflow docs #26998

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

Closed
story645 opened this issue Oct 4, 2023 · 0 comments · Fixed by #27093
Closed

[Doc]: Move Automated Tests section to workflow docs #26998

story645 opened this issue Oct 4, 2023 · 0 comments · Fixed by #27093
Milestone

Comments

@story645
Copy link
Member

story645 commented Oct 4, 2023

Documentation Link

https://matplotlib.org/devdocs/devel/coding_guide.html#automated-tests

Problem

This section on the automated tests is very useful and also buried in detailed guidelines and it's a mix of "writing PR" tasks and "prepping PR for merge" tasks and I think automated tests is sort of neither as it's something you may have to run a ton of times on a PR.
image

The only reason I found this section was because I knew it existed and had a guess at which of the three pages it might be in.

Suggested improvement

I'd find it more intuitive to put with the workflow information because that's where the other github related stuff lives:
image
and maybe leave an anchor link in the guidelines doc (which granted, I think needs a major overhaul #26095).

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this issue Oct 15, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this issue Oct 15, 2023
story645 added a commit that referenced this issue Oct 15, 2023
…093-on-v3.8.x

Backport PR #27093 on branch v3.8.x ([Doc]: Move Automated Tests section to workflow docs #26998)
story645 added a commit that referenced this issue Oct 15, 2023
…093-on-v3.8.0-doc

Backport PR #27093 on branch v3.8.0-doc ([Doc]: Move Automated Tests section to workflow docs #26998)
@QuLogic QuLogic added this to the v3.8-doc milestone Oct 16, 2023
story645 added a commit to story645/matplotlib that referenced this issue Oct 18, 2023
Accidentally missed this in my review on matplotlib#26998 but automated tests makes more sense as a standalone then as a subsection of commit history tasks.
@ksunden ksunden mentioned this issue Nov 2, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants