@@ -4,7 +4,7 @@ Contributing to LLVM
44
55
66Thank you for your interest in contributing to LLVM! There are multiple ways to
7- contribute, and we appreciate all contributions. In case you have questions,
7+ contribute, and we appreciate all contributions. If you have questions,
88you can either use the `Forum `_ or, for a more interactive chat, go to our
99`Discord server `_.
1010
@@ -20,14 +20,14 @@ Ways to Contribute
2020Bug Reports
2121-----------
2222If you are working with LLVM and run into a bug, we definitely want to know
23- about it. Please let us know and follow the instructions in
23+ about it. Please follow the instructions in
2424:doc: `HowToSubmitABug ` to create a bug report.
2525
2626Bug Fixes
2727---------
2828If you are interested in contributing code to LLVM, bugs labeled with the
2929`good first issue `_ keyword in the `bug tracker `_ are a good way to get familiar with
30- the code base. If you are interested in fixing a bug please comment on it to
30+ the code base. If you are interested in fixing a bug, please comment on it to
3131let people know you are working on it.
3232
3333Then try to reproduce and fix the bug with upstream LLVM. Start by building
@@ -43,8 +43,8 @@ There is a separate process to submit security-related bugs, see :ref:`report-se
4343
4444Bigger Pieces of Work
4545---------------------
46- In case you are interested in taking on a bigger piece of work, a list of
47- interesting projects is maintained at the `LLVM's Open Projects page `_. In case
46+ If you are interested in taking on a bigger piece of work, a list of
47+ interesting projects is maintained at the `LLVM's Open Projects page `_. If
4848you are interested in working on any of these projects, please post on the
4949`Forum `_, so that we know the project is being worked on.
5050
@@ -62,7 +62,7 @@ Once you have a patch ready, it is time to submit it. The patch should:
6262
6363.. _format patches :
6464
65- Before sending a patch for review, please also try to ensure it is
65+ Before sending a patch for review, please also ensure it is
6666formatted properly. We use ``clang-format `` for this, which has git integration
6767through the ``git-clang-format `` script. On some systems, it may already be
6868installed (or be installable via your package manager). If so, you can simply
@@ -108,7 +108,7 @@ you will likely want to run one of the following to add the changes to a commit:
108108
109109The LLVM project has migrated to GitHub Pull Requests as its review process.
110110For more information about the workflow of using GitHub Pull Requests see our
111- :ref: `GitHub <github-reviews >` documentation. We still have an read-only
111+ :ref: `GitHub <github-reviews >` documentation. We still have a read-only
112112`LLVM's Phabricator <https://reviews.llvm.org >`_ instance.
113113
114114To make sure the right people see your patch, please select suitable reviewers
@@ -146,12 +146,12 @@ For developers to commit changes from Git
146146 See also :ref: `GitHub <github-reviews >` for more details on merging your changes
147147 into LLVM project monorepo.
148148
149- Once a patch is reviewed , you can select the "Squash and merge" button in the
149+ Once a pull request is approved , you can select the "Squash and merge" button in the
150150GitHub web interface.
151151
152152When pushing directly from the command-line to the ``main `` branch, you will need
153153to rebase your change. LLVM has a linear-history policy, which means
154- that merge commits are not allowed and the ``main `` branch is configured to reject
154+ that merge commits are not allowed, and the ``main `` branch is configured to reject
155155pushes that include merges.
156156
157157GitHub will display a message that looks like this:
@@ -173,8 +173,8 @@ Please ask for help if you're having trouble with your particular git workflow.
173173Git pre-push hook
174174^^^^^^^^^^^^^^^^^
175175
176- We include an optional pre-push hook that run some sanity checks on the revisions
177- you are about to push and ask confirmation if you push multiple commits at once.
176+ We include an optional pre-push hook that runs some sanity checks on the revisions
177+ you are about to push and asks for confirmation if you push multiple commits at once.
178178You can set it up (on Unix systems) by running from the repository root:
179179
180180.. code-block :: console
0 commit comments