💡 [REQUEST] - Update CONTRIBUTING.md to include CI steps (e.g. pyspelling)
🚀 Describe the improvement or the new tutorial
Update CONTRIBUTING.md to include steps for testing CI steps (e.g. pyspelling) so that PRs are a little faster. The make html step doesn't test these items
https://github.com/pytorch/tutorials/blob/main/CONTRIBUTING.md
Existing tutorials on this topic
No response
Additional context
No response
Pretty much just run pyspelling from the root of the repo. It takes about 3 minutes to run.
To make it faster:
- To check only python files, run
pyspelling -n python(This still takes like 3 minutes) - to check .rst only:
pyspelling -n reST. Currently, for.rstfiles only the beginner/ dir is included. PRs a welcome to fix spelling in other dirs for.rst.
We could add this to README.md.
Thanks! I am happy to do it after I collect all the dings from my PR.
What time limit guidance should we put in the documentation? My original submission took 30 minutes on CPU but I reduced it to 70 seconds. Is 10 minutes on a local device a good number of 5 minutes better?
It ran about 3 minutes for me. 5 minutes should be fine.
/assigntome