Skip to content

Commit c0618a3

Browse files
janeyx99pytorchmergebot
authored andcommitted
Update commitlist.py instructions for the GitHub repo regime (pytorch#149535)
Pull Request resolved: pytorch#149535 Approved by: https://github.com/albanD
1 parent 76994d4 commit c0618a3

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

scripts/release_notes/commitlist.py

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@
3232
3333
"""
3434

35+
# Increase the allowed size of a CSV field to 1mil bytes for long files changed
36+
csv.field_size_limit(1000000)
37+
3538

3639
@dataclasses.dataclass(frozen=False)
3740
class Commit:
@@ -490,15 +493,15 @@ def get_markdown_header(category):
490493
header = f"""
491494
# Release Notes worksheet {category}
492495
493-
The main goal of this process is to rephrase all the commit messages below to make them clear and easy to read by the end user. You should follow the following instructions to do so:
496+
The main goal of this process is to rephrase all the commit messages below to make them **clear and easy to read** by the end user. You should follow the following instructions to do so:
494497
495-
* **Please cleanup, and format commit titles to be readable by the general pytorch user.** [Detailed instructions here](https://docs.google.com/document/d/14OmgGBr1w6gl1VO47GGGdwrIaUNr92DFhQbY_NEk8mQ/edit)
498+
* **Please clean up and format commit titles to be readable by the general PyTorch user.** Make sure you're [following the guidance here](https://docs.google.com/document/d/14OmgGBr1w6gl1VO47GGGdwrIaUNr92DFhQbY_NEk8mQ/edit)! Your resulting notes must be consistent and easy to read.
496499
* Please sort commits into the following categories (you should not rename the categories!), I tried to pre-sort these to ease your work, feel free to move commits around if the current categorization is not good.
497-
* Please drop any commits that are not user-facing.
498-
* If anything is from another domain, leave it in the UNTOPICED section at the end and I'll come and take care of it.
499-
* Please use markdown format
500-
* Please use #PR_NUM to link to the PR, instead of `[#PR_NUM](https://github.com/pytorch/pytorch/pull/#PR_NUM)` to reduce the length of the release notes
501-
* We place a lot of emphasis on the “BC-breaking” and “deprecation” sections. Those should be where the most effort goes in. The “improvements” and “bug fixes” for Python API should be nice as well. Everything else doesn’t matter too much so feel free to cut corners if time is short.
500+
* Anything that is not public facing needs to be removed.
501+
* If anything is miscategorized/belongs to another domain, move it to `miscategorized.md`.
502+
* Please scan through `miscategorized.md` and handle any commits that belong within your domain according to these instructions.
503+
* We place a lot of emphasis on the “BC-breaking” and “deprecation” sections. Those should be where the most effort goes in. The “improvements” and “bug fixes” for Python API should be nice as well.
504+
* Once you are finished, move this very file from `todo/` to `done/` and submit a pull request.
502505
503506
The categories below are as follows:
504507
@@ -510,6 +513,7 @@ def get_markdown_header(category):
510513
* performance: All commits that are added mainly for performance (we separate this from improvements above to make it easier for users to look for it)
511514
* documentation: All commits that add/update documentation
512515
* Developers: All commits that are not end-user facing but still impact people that compile from source, develop into pytorch, extend pytorch, etc
516+
* not user facing: All commits that are not public end-user facing and hence should be dropped from the release notes
513517
"""
514518

515519
return [header]

0 commit comments

Comments
 (0)