issue_comments

Thanks for these comment @paigem! It's useful to hear things that might not occur to us.

Good points @Illviljan. Perhaps we should restructure to make it clear that running tests / pre-commit locally is optional, but still show people how to do it?

I've found this part of the documentation a bit scary in the past because there is so much stuff to do for a simple "typo fix" so I welcome changes here!

Nowadays, since the CI runs pytest, ASV performance benchmarks, pre-commit and builds the documentation on every PR it isn't really necessary for new contributors to get it to run locally. The only thing left is setting up a new branch with git, change the code and create a PR. If the CI fails check the details of that test, correct the code, push a new commit. Setting up git can also be scary for new users but then there is github desktop which hides away all of that in a quite user friendly GUI.

Sure, if you're doing bigger changes running the specific tests locally is probably faster but at that point you're probably a more experienced contributor anyway.

One more comment (now that my docstring PR went through): - We should include something like the following under the section Finally, make the pull request : - "If you have made updates to the documentation, you can see a preview of the updated docs by clicking on "Details" under the docs/readthedocs.org check near the bottom of the list of checks that run automatically when submitting a PR."