Create tutorial_submission_policy.md #2995
Conversation
svekars
commented
Aug 8, 2024
svekars
commented
- Add a policy for new tutorials submissions
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/2995
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit 3930f09 with merge base ea2dfc6 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
tutorial_submission_policy.md
Outdated
| a review process. If you are interested in contributing a tutorial, please follow these steps: | ||
|
|
||
| 1. **Create an issue:** | ||
| * Open an issue in the pytorch/tutorials repository proposing the new tutorial. Clearly |
There was a problem hiding this comment.
Do you have an issue template with directed questions they should be answering in their proposal? That might help get consistent submissions.
There was a problem hiding this comment.
I do have a template for requesting a new tutorial: https://github.com/pytorch/tutorials/blob/main/.github/ISSUE_TEMPLATE/feature-request.yml I can repurpose it a bit to make it both request and proposal
tutorial_submission_policy.md
Outdated
| * Each tutorial must be updated by its owners at least once a year. Tutorials that are | ||
| abandoned by the owners will be eventually deprecated. | ||
|
|
||
| We reserve the right to decline any new tutorial submissions that do not follow this policy. |
There was a problem hiding this comment.
This feels overly formal and already implied.
tutorial_submission_policy.md
Outdated
| 1. **Maintenance:** | ||
| * By submitting a new tutorial, you agree to maintain it up-to-date with the latest PyTorch | ||
| updates and new features, review issues and pull requests and bugs submitted against the | ||
| tutorials and overall take proactive actions to ensure quality of the tutorial. | ||
| * Each tutorial must be updated by its owners at least once a year. Tutorials that are | ||
| abandoned by the owners will be eventually deprecated. |
There was a problem hiding this comment.
I 100% agree we need this section but the current content sounds a bit underspecified compared to the rest of the doc.
In particular, even if a user wanted to follow the first point, would they have to follow every single issue happening on the repo and look for the ones about their tutorial?
Also for the second what happens if their tutorial doesn't need update?
Reading in between the lines, my guess is what you are trying to get here are:
- An owner for each tutorial -> let have these as a comment on the file somewhere, and make it required for all new tutorials / updates. (similar to core test file owners).
- Have an SLA on answering issue -> let's make this an SLA: the owner will be pinged on the issue and should answer within 1months or we'll consider the tutorial as "deprecated"
- Have a way to remove old tutorials -> any "deprecated" tutorial will be unlisted immediatly, an issue will be open about it, pinging the owner, if there is no answer within a month, the tutorial can get deleted at the maintainer's discretion.
WDYT?
- Add a policy for new tutorials submissions
svekars
force-pushed
the
svekars-patch-28
branch
from
e97ff90 to
e0d50be
Compare
Co-authored-by: albanD <[email protected]>
Co-authored-by: Nikita Shulga <[email protected]>
Co-authored-by: Nikita Shulga <[email protected]>
Co-authored-by: Nikita Shulga <[email protected]>
- Add a policy for new tutorials submissions --------- Co-authored-by: albanD <[email protected]> Co-authored-by: Nikita Shulga <[email protected]>
- Add a policy for new tutorials submissions --------- Co-authored-by: albanD <[email protected]> Co-authored-by: Nikita Shulga <[email protected]>
