Commit 37f2b4f0 authored by Xiaohui Zhang's avatar Xiaohui Zhang Committed by Facebook GitHub Bot
Browse files

adjust reference PR labels and add labeling guidance (#3162)

Summary: Pull Request resolved: https://github.com/pytorch/audio/pull/3162

Reviewed By: mthrok

Differential Revision: D43964995

Pulled By: xiaohui-zhang

fbshipit-source-id: bba8fffe25f2f39f558f080fef319b1df4c6e440
parent 27471a02
......@@ -20,20 +20,21 @@ PRIMARY_LABELS = {
"bug fix",
"new feature",
"improvement",
"tutorial",
"recipe",
"prototype",
"other",
}
SECONDARY_LABELS = {
"module: I/O",
"module: io",
"module: ops",
"module: models",
"module: pipelines",
"module: datasets",
"module: docs",
"module: tests",
"tutorial",
"recipe",
"example",
"build",
"style",
"perf",
......@@ -73,7 +74,27 @@ def post_github_comment(pr_number: int, merger: str) -> Any:
"body": f"Hey @{merger}."
+ """
You merged this PR, but labels were not properly added. Please add a primary and secondary label \
(See https://github.com/pytorch/audio/blob/main/.github/process_commit.py)"""
(See https://github.com/pytorch/audio/blob/main/.github/process_commit.py).
Some guidance:
Use 'module: ops' for operations under 'torchaudio/{transforms, functional}', \
and ML-related components under 'torchaudio/csrc' (e.g. RNN-T loss).
Things in "examples" directory:
'recipe' is applicable to training recipes under the 'examples' folder,
'tutorial' is applicable to tutorials under the “examples/tutorials” folder
'example' is applicable to everything else (e.g. C++ examples)
'module: docs' is applicable to code documentations (not to tutorials). \
Regarding examples in code documentations, please also use 'module: docs'.
Please use 'other' tag only when you’re sure the changes are not much relevant to users, \
or when all other tags are not applicable. Try not to use it often, in order to minimize \
efforts required when we prepare release notes.
When preparing release notes, please make sure 'documentation' and 'tutorials' occur as the \
last sub-categories under each primary category like 'new feature', 'improvements' or 'prototype'.
Things related to build are by default excluded from the release note, except when it impacts users.
For example:
* Drop support of Python 3.7.
* Add support of Python 3.X.
* Changing the way a third party library is bound (so that user needs to install it separately).
"""
}
response = requests.post(
......
......@@ -14,20 +14,22 @@ primary_labels_mapping = {
"bug fix": "Bug Fixes",
"new feature": "New Features",
"improvement": "Improvements",
"example": "Examples",
"prototype": "Prototypes",
"other": "Other",
"None": "Missing",
}
secondary_labels_mapping = {
"module: I/O": "I/O",
"module: io": "I/O",
"module: ops": "Ops",
"module: models": "Models",
"module: pipelines": "Pipelines",
"module: datasets": "Datasets",
"module: docs": "Documentation",
"module: tests": "Tests",
"tutorial": "Tutorials",
"recipe": "Recipes",
"example": "Examples",
"build": "Build",
"style": "Style",
"perf": "Performance",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment