[PATCH] D146819: [llvm][github] Add good-first-issue comment to issues
Timm Bäder via Phabricator via llvm-commits
llvm-commits at lists.llvm.org
Thu Apr 13 05:40:46 PDT 2023
This revision was landed with ongoing or failed builds.
This revision was automatically updated to reflect the committed changes.
Closed by commit rG09effa706a02: [llvm][github] Add good-first-issue comment to issues (authored by tbaeder).
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D146819/new/
https://reviews.llvm.org/D146819
Files:
llvm/utils/git/github-automation.py
Index: llvm/utils/git/github-automation.py
===================================================================
--- llvm/utils/git/github-automation.py
+++ llvm/utils/git/github-automation.py
@@ -18,6 +18,27 @@
import time
from typing import List, Optional
+beginner_comment =
+"""
+Hi!
+
+This issue may be a good introductory issue for people new to working on LLVM. If you would like to work on this issue, your first steps are:
+
+ 1) Assign the issue to you.
+ 2) Fix the issue locally.
+ 3) [Run the test suite](https://llvm.org/docs/TestingGuide.html#unit-and-regression-tests) locally.
+ 3.1) Remember that the subdirectories under `test/` create fine-grained testing targets, so you can
+ e.g. use `make check-clang-ast` to only run Clang's AST tests.
+ 4) Create a `git` commit
+ 5) Run [`git clang-format HEAD~1`](https://clang.llvm.org/docs/ClangFormat.html#git-integration) to format your changes.
+ 6) Submit the patch to [Phabricator](https://reviews.llvm.org/).
+ 6.1) Detailed instructions can be found [here](https://llvm.org/docs/Phabricator.html#requesting-a-review-via-the-web-interface)
+
+For more instructions on how to submit a patch to LLVM, see our [documentation](https://llvm.org/docs/Contributing.html).
+
+If you have any further questions about this issue, don't hesitate to ask via a comment on this Github issue.
+"""
+
class IssueSubscriber:
@property
@@ -34,7 +55,12 @@
for team in self.org.get_teams():
if self.team_name != team.name.lower():
continue
- comment = '@llvm/{}'.format(team.slug)
+
+ comment = ''
+ if team.slug == 'issue-subscribers-good-first-issue':
+ comment = '{}\n'.format(beginner_comment)
+
+ comment += '@llvm/{}'.format(team.slug)
self.issue.create_comment(comment)
return True
return False
-------------- next part --------------
A non-text attachment was scrubbed...
Name: D146819.513195.patch
Type: text/x-patch
Size: 1915 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20230413/786028ee/attachment.bin>
More information about the llvm-commits
mailing list