[llvm] [GitHub] Use proper Markdown syntax and avoid child list items (PR #73700)

Danny Mösch via llvm-commits llvm-commits at lists.llvm.org
Tue Nov 28 13:09:37 PST 2023


https://github.com/SimplyDanny created https://github.com/llvm/llvm-project/pull/73700

None

>From 508965d3c3414c1f98355f778002d0a481088e94 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Danny=20M=C3=B6sch?= <danny.moesch at icloud.com>
Date: Tue, 28 Nov 2023 22:02:22 +0100
Subject: [PATCH] [GitHub] Use proper Markdown syntax and avoid child list
 items

---
 llvm/utils/git/github-automation.py | 19 ++++++++-----------
 1 file changed, 8 insertions(+), 11 deletions(-)

diff --git a/llvm/utils/git/github-automation.py b/llvm/utils/git/github-automation.py
index d8adb4650e525e2..3f24132ae8e3c26 100755
--- a/llvm/utils/git/github-automation.py
+++ b/llvm/utils/git/github-automation.py
@@ -24,17 +24,14 @@
 
 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) In the comments of the issue, request for it to be assigned 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) Open a [pull request](https://github.com/llvm/llvm-project/pulls) to the [upstream repository](https://github.com/llvm/llvm-project) on GitHub.
-    6.1) Detailed instructions can be found [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
-
-If you have any further questions about this issue, don't hesitate to ask via a comment on this Github issue.
+1. In the comments of the issue, request for it to be assigned to you.
+2. Fix the issue locally.
+3. [Run the test suite](https://llvm.org/docs/TestingGuide.html#unit-and-regression-tests) locally. 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. Open a [pull request](https://github.com/llvm/llvm-project/pulls) to the [upstream repository](https://github.com/llvm/llvm-project) on GitHub. Detailed instructions can be found [in GitHub's documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
+
+If you have any further questions about this issue, don't hesitate to ask via a comment in the thread below.
 """
 
 



More information about the llvm-commits mailing list