Skip to content

Update CONTRIBUTING.md #3387

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

Merged
sekyondaMeta merged 2 commits into from
Jun 13, 2025
Merged

Update CONTRIBUTING.md #3387

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4018ac5
update readme
krishnakalyan3 Jun 9, 2025
52c8608
update with feedback
krishnakalyan3 Jun 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ GALLERY_PATTERN="neural_style_transfer_tutorial.py" sphinx-build . _build

The `GALLERY_PATTERN` variable respects regular expressions.

## Spell Check
You can run pyspelling to check for spelling errors in the tutorials. To check only Python files, run pyspelling -n python. To check only .rst files, use pyspelling -n reST. Currently, .rst spell checking is limited to the beginner/ directory. Contributions to enable spell checking in other directories are welcome!


```
pyspelling # full check (~3 mins)
pyspelling -n python # Python files only
pyspelling -n reST # reST files (only beginner/ dir currently included)
```


## About contributing to PyTorch Documentation and Tutorials
* You can find information about contributing to PyTorch documentation in the
Expand Down