[PATCH] D146819: [llvm][github] Add good-first-issue comment to issues

Aaron Ballman via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Thu Mar 30 05:12:45 PDT 2023


aaron.ballman added a comment.

Thank you for working on this, I think it's a really good idea! One issue I see with it though is that the GitHub issues list is used by multiple projects (llvm, clang, lldb, libc++, etc) but the way in which you contribute to these projects differ. So I think these instructions will work great for most folks, but we may want to consider the other projects and whether we need to adjust any wording here accordingly. (Personally, I think any project within the monorepo that diverges from the usual policies sufficiently enough to cause problems like this should either consider moving out of the monorepo or changing their policies to be in line with the rest of the monorepo, but that's a much bigger discussion than this patch. I think this patch kind of demonstrates why those policy differences cause friction for new contributors.)



================
Comment at: llvm/utils/git/github-automation.py:34
+  4) Create a `git` commit
+  5) Run `git clang-format HEAD~1` to format your changes.
+  6) Submit the patch to [Phabricator](https://reviews.llvm.org/).
----------------
Do we want to link to https://clang.llvm.org/docs/ClangFormat.html#git-integration around here?


================
Comment at: llvm/utils/git/github-automation.py:36
+  6) Submit the patch to [Phabricator](https://reviews.llvm.org/).
+    6.1) Don't forget to upload your patch with sufficient context, e.g. `git show HEAD -U99990`.
+
----------------



================
Comment at: llvm/utils/git/github-automation.py:38
+
+For more instructions on how to submit a patch to LLVM, see our [documentation](https://llvm.org/docs/Contributing.html).
+
----------------
Given that Phabricator may be unknown to folks new to the community, do we also want to add a link to https://llvm.org/docs/Phabricator.html somewhere in here or do we think the contributing guide should suffice?


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D146819



More information about the llvm-commits mailing list