[PATCH] D117832: Update the Bug Life Cycle docs for the switch to GitHub issues

Arthur O'Dwyer via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Fri Jan 21 09:33:15 PST 2022


Quuxplusone accepted this revision.
Quuxplusone added a comment.
This revision is now accepted and ready to land.

Awesome!



================
Comment at: llvm/docs/BugLifeCycle.rst:19
 
 At the same time, we aim to not over-specify the life cycle of bugs in the
+`the LLVM Bug Tracking System <https://github.com/llvm/llvm-project/issues>`_,
----------------



================
Comment at: llvm/docs/BugLifeCycle.rst:32
+Furthermore, some of the metadata in the bug tracker, such as what labels we
+use needs to be maintained. See the following for details:
 
----------------



================
Comment at: llvm/docs/BugLifeCycle.rst:77-79
+* When able to do so, please add the appropriate labels to classify the bug,
+  such as the tool (``clang``, ``clang-format``, ``clang-tidy``, etc) or
+  component (``backend:<name>``, ``compiler-rt:<name>``, ``clang:<name>``, etc).
----------------
If you think it would be uncontroversial, I'd add:
```
* Don't use both a general and a specific label; for example, bugs labeled ``c++17`` shouldn't also have ``c++``, and bugs labeled ``clang:codegen`` shouldn't also have ``clang``.
```
(but if you think that's opening a can of worms for this PR, then ignore me)


================
Comment at: llvm/docs/BugLifeCycle.rst:85
+* Add the ``good first issue`` label if you think this would be a good bug to
+  be fixed by someone new to LLVM.
+  
----------------



================
Comment at: llvm/docs/BugLifeCycle.rst:88
+* If you are unsure of what a label is intended to be used for, please see the
+  `documentation for labels <https://github.com/llvm/llvm-project/labels>`_.
 
----------------



================
Comment at: llvm/docs/BugLifeCycle.rst:110
+    the fix yourself, your git commit message may include the phrase
+    `Fixes #<issue number>` on a line by itself. GitHub recognizes such commit
+    messages and will automatically close the specified issue with a reference
----------------



CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D117832/new/

https://reviews.llvm.org/D117832



More information about the llvm-commits mailing list