Skip to content

Commit c791556

Browse files
committed
Address comments, fix typos
1 parent 93e7ce3 commit c791556

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

tutorial_submission_policy.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ We accept new tutorials that adhere to one of the following use cases:
1515
* **Demonstrate New PyTorch Features:** Tutorials that support new features
1616
for upcoming PyTorch releases are typically authored by the engineers who
1717
are developing these features. These tutorials are crucial for showcasing
18-
the latest advancements in PyTorch. We typically don't require more than
18+
the latest advancements in PyTorch. We typically do not require more than
1919
one tutorial per feature.
2020

2121
* **Tutorials showcasing PyTorch usage with other tools and libraries:** We
@@ -44,9 +44,9 @@ interested in contributing a tutorial, please follow these steps:
4444
to ensure your content adheres to these guidelines.
4545
Use the provided [ISSUE_TEMPLATE](https://github.com/pytorch/tutorials/blob/main/.github/ISSUE_TEMPLATE/feature-request.yml) for the new tutorial request - select **Feature request** when submitting an issue. .
4646

47-
* If there is a tutorial on the existing topic that you would like
48-
to significantly refactor, you can just submit a PR. In the
49-
description of the PR explain why the changes are needed and
47+
* If there is an existing tutorial on the topic that you would
48+
like to significantly refactor, you can submit a PR. In the
49+
description of the PR, explain why the changes are needed and
5050
how they improve the tutorial.
5151

5252
* These issues will be triaged by PyTorch maintainers on a case-by-case basis.
@@ -56,14 +56,14 @@ interested in contributing a tutorial, please follow these steps:
5656
* Wait for a response from the PyTorch Tutorials maintainers. A PyTorch
5757
tutorial maintainer will review your proposal and
5858
determine whether a tutorial on the proposed topic is desirable.
59-
A comment and an **approved** label will be added to your tutorial
60-
by a maintainer. Review process for new tutorial PRs submitted
61-
without the corresponding issue will take longer.
59+
A comment and an **approved** label will be added to your issue
60+
by a maintainer. The review process for new tutorial PRs submitted
61+
without the corresponding issue may take longer.
6262

6363
1. **Adhere to writing and styling guidelines:**
6464
* Once approved, follow the guidelines outlined in [CONTRIBUTING.md](https://github.com/pytorch/tutorials/blob/main/CONTRIBUTING.md)
6565
and use the provided [template](https://github.com/pytorch/tutorials/blob/main/beginner_source/template_tutorial.py) for creating your tutorial.
66-
* Link the issue in which you received an approval for your tutorial
66+
* Link the issue in which you received approval for your tutorial
6767
in the PR.
6868
* We accept tutorials in both ``.rst`` (ReStructuredText) and ``.py``
6969
(Python) formats. However, unless your tutorial involves using
@@ -73,25 +73,26 @@ interested in contributing a tutorial, please follow these steps:
7373

7474
## Maintaining Tutorials
7575

76-
When you submit a new tutorial, we encourage you to keep it updated
76+
When you submit a new tutorial, we encourage you to keep it in sync
7777
with the latest PyTorch updates and features. Additionally, we may
7878
contact you to review any PRs, issues, and other related matters to
7979
ensure the tutorial remains a valuable resource.
8080

8181
Please note the following:
8282

83-
* If a tutorial is broken against the main branch, the tutorial will
84-
be excluded from the build and an issue will be filed against it
85-
with the author/maintainer notified about the issue. If the issue
86-
is not resolved within 90 days, the tutorial might be deleted from
87-
the repository.
83+
* If a tutorial breaks against the main branch, it will
84+
be excluded from the build and an issue will be filed against it,
85+
with the author/maintainer notified. If the issue is not resolved
86+
within 90 days, the tutorial might be deleted from the repository.
8887

8988
* We recommend that each tutorial is reviewed at least once a year to
9089
ensure its relevance.
9190

9291
## Deleting Stale Tutorials
9392

94-
A tutorial might be considered stale when it no longer aligns with the latest PyTorch updates, features, or best practices or:
93+
A tutorial might be considered stale when it no longer aligns with
94+
the latest PyTorch updates, features, or best practices or best
95+
practices:
9596

9697
* The tutorial is no longer functional due to changes in PyTorch or
9798
its dependencies
@@ -100,7 +101,7 @@ A tutorial might be considered stale when it no longer aligns with the latest Py
100101
* The tutorial does not run successfully in the (CI), indicating
101102
potential compatibility or dependency issues.
102103

103-
If a tutorial is deemed stale, we will attempt to contact the code owner
104+
If a tutorial is deemed stale, we will attempt to contact the code owner,
104105
or someone from the tutorial mainatainers might attempt to update it.
105-
However, if despite those attempts, we fail to fix it, the tutorial
106+
However, if despite those attempts we fail to fix it, the tutorial
106107
might be removed from the repository.

0 commit comments

Comments
 (0)