Final wording adjustments

jhelsby · jhelsby · commit e9662f7160c4 · 2025-04-10T20:51:38.000+02:00
diff --git a/docs/source/new-contributor-guide.md b/docs/source/new-contributor-guide.md
@@ -4,7 +4,7 @@ Welcome to **ExecuTorch** — a runtime for efficient deployment of PyTorch AI m
 
 If you're new to ExecuTorch, open-source projects, or GitHub, this guide is for you. We're excited to have you on board!
 
-If you have any questions, issues comments, or just want to say hello to our community, please feel free to introduce yourselves on our **[Discord Server](https://discord.com/invite/Dh43CKSAdc)**. We'd love to speak with you.
+If you have any questions, issues, comments, or just want to say hello to our community, please feel free to introduce yourselves on our **[Discord Server](https://discord.com/invite/Dh43CKSAdc)**. We'd love to speak with you.
 
 ---
 
@@ -14,7 +14,7 @@ If you have any questions, issues comments, or just want to say hello to our com
 
 This guide assumes a basic knowledge of Git, and how to run Git commands in your terminal. If you've never used Git before, you can read [this quick guide](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/), [git guide](https://rogerdudler.github.io/git-guide/), [cheat sheet](https://towardsdatascience.com/git-commands-cheat-sheet-software-developer-54f6aedc1c46/), the [Setup Git](https://docs.github.com/en/get-started/git-basics/set-up-git) page from GitHub’s documentation, or watch one of the many tutorials on YouTube.
 
-Git is a powerful version control system for coding projects — it enables you to collaborate, record code changes, and avoid losing hours of work when you make a mistake. It is essential for projects like ExecuTorch, with large codebases and many collaborators. Without it, the complexity of tracking everyone's changes, reviewing their code, and identifying bugs quickly becomes unmanageable.
+Git is a powerful version control system for coding projects — it enables you to collaborate, record code changes, and avoid losing hours of work when you make a mistake. It is essential for projects like ExecuTorch with large codebases and many collaborators. Without it, the complexity of tracking everyone's changes, reviewing their code, and identifying bugs, quickly becomes unmanageable.
 
 Git is an industry standard in the coding world, and particularly in open-source. It can take a while to get used to at first, but we promise you it's well worth the effort! We believe that learning Git can make you a significantly stronger and more effective developer.
 
@@ -56,7 +56,7 @@ Before you can start writing any code, you need to get a copy of ExecuTorch code
 
     ![](./_static/img/new-contributor-guide/how_to_fork1.png)
 
-    This will take you to another page - click `Create fork`:
+    This will take you to another page. Click `Create fork`:
 
     ![](./_static/img/new-contributor-guide/how_to_fork2.png)
 
@@ -79,7 +79,7 @@ Before you can start writing any code, you need to get a copy of ExecuTorch code
     Assuming you're in the same directory you cloned into, run:
 
     ```bash
-    cd executorch            # enter the cloned project
+    cd executorch # enter the cloned project
     git remote add upstream https://github.com/pytorch/executorch.git
     ```
 
@@ -104,7 +104,7 @@ Before you can start writing any code, you need to get a copy of ExecuTorch code
 
       * The `upstream` entries show the main ExecuTorch repository. If you want to sync the latest changes from there, you can run `git fetch upstream`.
 
-    Let's sync from both your fork _and_ the main ExecuTorch branch, to get the latest changes from each of them. To do this, run:
+    Let's sync from both your fork _and_ the main ExecuTorch branch, getting the latest changes from each of them. To do this, run:
 
     ```bash
     git fetch --all --prune
@@ -114,7 +114,7 @@ Before you can start writing any code, you need to get a copy of ExecuTorch code
 
     ![](./_static/img/new-contributor-guide/synced_fork.png)
 
-    However, ExecuTorch updates frequently - if it's been a while you visited your fork, you might not have the latest version anymore. It's important to keep your fork as up-to-date as possible. Otherwise, the code changes you're making might fix your issue for an old version of the codebase, but _not_ for the current version.
+    However, ExecuTorch updates frequently — if it's been a while you visited your fork, you might not have the latest version anymore. It's important to keep your fork as up-to-date as possible. Otherwise, the code changes you're making might fix your issue for an old version of the codebase, but _not_ fix it for the current version.
 
     GitHub will tell you if your fork is out-of-date. To synchronise the necessary changes, click `Sync fork`, then `Update branch` as shown:
 
@@ -161,7 +161,7 @@ Great job — you're all set up. Now you can actually start coding!
 2. Make your changes. For bugfixes, we recommend a test-driven workflow:
     - Find a test case that demonstrates your bug.
     - Verify that your new test case fails on the `main` branch.
-    - Add that example as an automated test, and assert the expected, failing results. If you can, try to make this test as minimal as possible to reduce interference with some other issue.
+    - Add that example as an automated test, and assert the expected failing results. If you can, try to make this test as minimal as possible to reduce interference with some other issue.
 
     Once you have a failing test, you can keep working on the issue and running the test until it passes.
 
@@ -182,7 +182,9 @@ Great job — you're all set up. Now you can actually start coding!
     * [[ET-VK][ez] Allow logit linear layer to be lowered to Vulkan](https://github.com/pytorch/executorch/pull/9951/commits/3fdd8cab8c58db0be666f3454c41f73ad5964743)
     * [Allow emitting mutable buffer names in schema](https://github.com/pytorch/executorch/pull/9935/commits/773a34725afea6c0bf1b99d02a9cefb91c4960e1)
 
-4. When you are done making changes and the test case you added is passing, [run the same tests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#testing) you ran at the end of the [Prepare Your Workspace](#prepare-your-workspace) section. If any fail now that were working previously, it means your changes have broken some existing functionality. You'll need to dig back into your code to figure out what's gone wrong.
+4. When you are done making changes and the test case you added is passing, [run the same tests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#testing) you ran earlier (at the end of the [Prepare Your Workspace](#prepare-your-workspace) section).
+
+    If any tests fail now which were working before, it means your changes have broken some existing functionality. You'll need to dig back into your code to figure out what's gone wrong.
 
 5. Once your new test _and_ the old tests are all working as intended, upload/push these changes to your fork:
 
@@ -211,8 +213,6 @@ Once you've successfully finished local development, it's time to send out your
 
     In the description, you’ll describe all the changes you’ve made.
 
-    Ensure that all tests are passing. If not, click on a failing test to see what went wrong and make the required changes.
-
 3. If you want to submit your PR right away, you can go ahead and click the Green `Create pull request` button. However, please note that this will immediately notify all reviewers. We strongly recommend creating a Draft PR first. This will allow you to perform some extra checks first:
 
     * You can get some early feedback on your PR without notifying everybody.
@@ -221,17 +221,17 @@ Once you've successfully finished local development, it's time to send out your
 
     * Creating it will start CI (["Continuous Integration"](https://en.wikipedia.org/wiki/Continuous_integration)) checks to verify that all tests pass under various configurations. If some tests fail, you can fix them before creating the final PR.
 
-    To do submit a draft, click the arrow next to the `Create Pull Request` button:
+    To do submit a draft, click the arrow next to the `Create Pull Request` button, then click `Create draft pull request` in the dropdown menu:
 
     ![](./_static/img/new-contributor-guide/how_to_draft_pr1.png)
 
-    Then click `Create draft pull request` in the dropdown menu. This will change the green button's text to `Draft pull request`:
+    This will change the green button's text to `Draft pull request`:
 
     ![](./_static/img/new-contributor-guide/how_to_draft_pr2.png)
 
     Click it to create your draft PR.
 
-4. After you click the `Draft pull request` button, it will take you to your Draft PR page. It might look something like this:
+4. This will take you to your Draft PR page. It might look something like this:
 
     ![](./_static/img/new-contributor-guide/how_to_draft_pr3.png)
 
@@ -257,9 +257,13 @@ Once you've successfully finished local development, it's time to send out your
 
     * At the end of your Draft PR, you'll see something like this:
 
-        ![](./_static/img/new-contributor-guide/end_of_draft_pr.png)
+        ![](./_static/img/new-contributor-guide/end_of_draft_pr1.png)
+
+        This is a summary of all the CI checks and requirements which need to be satisfied before your PR can be merged. Ensure that all tests are passing. If not, click on a failing test to see what went wrong and make the required changes.
 
-        This is a summary of all the CI checks and requirements which need to be satisfied before your PR can be merged. Once you're happy with your draft, you can click the `Ready for review` button to create your PR.
+        Once you're happy with your draft, you can click the `Ready for review` button to create your PR:
+
+        ![](./_static/img/new-contributor-guide/end_of_draft_pr2.png)
 
 5. Now you've created your PR, it's time for your changes to be reviewed by the ExecuTorch community and maintainers.
 
@@ -268,3 +272,5 @@ Once you've successfully finished local development, it's time to send out your
     Those reviewers/maintainers are here to finetune your contribution and eventually catch some issues before we merge the PR. We aim for this process to be pleasing on both sides: we try to give and get the best.
 
     Once the reviewers are happy, one of our core contributors will merge your PR. Congratulations — you're now an official ExecuTorch contributor!
+
+Great job making it to the end of our guide — we hope you enjoy contributing. Once again, please check out **[Discord Server](https://discord.com/invite/Dh43CKSAdc)** if you want to say hello, ask any questions, or talk about any and all things ExecuTorch. We look forward to receiving your contributions!
