[tor-commits] [community/staging] Normalize punctuation usage

Sun Mar 21 19:17:29 UTC 2021

commit eb380c814c4e4f911f629b79236496cf49ad030f
Author: null pointer exception <57326449+deathgrippin at users.noreply.github.com>
Date:   Sun May 24 18:59:19 2020 +0000

    Normalize punctuation usage
---
 README.md | 41 ++++++++++++++++++++---------------------
 1 file changed, 20 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 1c3aa94..43c5592 100644
--- a/README.md
+++ b/README.md
@@ -43,7 +43,7 @@ You can click ```Edit this page``` and submit your content changes in a [Pull Re
 
 5. Translations for the website are imported by Jenkins when bulding the page, but if you want to test them, download the correct branch of the translations repo to the ./i18n/ folder.
 
-6. Finally
+6. Finally:
 
 To run a local continuous builder: ```$ lektor server```
 
@@ -57,7 +57,6 @@ Check our [wiki pages](https://dip.torproject.org/web/community/wikis/How-to-dev
 
 To help us to translate, please join the Tor Project team in [Transifex](https://www.transifex.com/).
 
-
 ### Getting help
 
 If you want to contribute to the Community portal, we will be happy to help you. Join us at #tor-www in [irc.oftc.net](https://www.oftc.net).
@@ -69,30 +68,30 @@ If you want to contribute to the Community portal, we will be happy to help you.
 This is the workflow that Tor Internal people should use when making changes on the Community Portal:
 
 1. When starting work on an issue or content, please assign the issue to yourself and move into the `Doing` column on the [Community Portal Project Board](https://dip.torproject.org/web/community/-/boards). You can follow the process outlined in ["How to send a merge request or propose a change"](https://dip.torproject.org/web/tpo/wikis/Git-flow-and-merge-requests#how-to-send-a-merge-request-or-propose-a-change) to work on your changes.
-2. To view your changes on the website, you can [run lektor locally](https://dip.torproject.org/web/tpo/wikis/Compiling-a-local-version-of-the-website)
-3. Once you are happy with your work, push your changes to `develop` branch and move to `needs-review` column on the [Community Portal Project Board](https://dip.torproject.org/web/community/-/boards)
-4. Add a comment to the issue, tagging the reviewer, e.g `@steph`, with:
-    - Location of page on lektor-staging `develop` branch, e.g https://lektor-staging.torproject.org/community/develop/
-    - Contents file, containing your changes where it would be located on the **reviewer's repo** e.g `https://dip.torproject.org/steph/community/blob/develop/content/onion-services/contents.lr`
-    - For the review workflow, please see (Reviewer Workflow)
-5. Once the work has been reviewed and any necessary changes and merge request has been made, a repo maintainer or team members with write access to gitweb master will then merge or cherry-pick these changes to master, following the workflow outlined in [How to use our git flow](https://dip.torproject.org/web/tpo/wikis/Git-flow-and-merge-requests#how-to-use-our-git-flow)
+2. To view your changes on the website, you can [run lektor locally](https://dip.torproject.org/web/tpo/wikis/Compiling-a-local-version-of-the-website).
+3. Once you are happy with your work, push your changes to `develop` branch and move to `needs-review` column on the [Community Portal Project Board](https://dip.torproject.org/web/community/-/boards).
+4. Add a comment to the issue, tagging the reviewer, e.g. `@steph`, with:
+    - Location of page on lektor-staging `develop` branch, e.g. https://lektor-staging.torproject.org/community/develop/.
+    - Contents file, containing your changes where it would be located on the **reviewer's repo**, e.g. `https://dip.torproject.org/steph/community/blob/develop/content/onion-services/contents.lr`.
+    - For the review workflow, please see (Reviewer Workflow).
+5. Once the work has been reviewed and any necessary changes and merge request has been made, a repo maintainer or team members with write access to gitweb master will then merge or cherry-pick these changes to master, following the workflow outlined in [How to use our git flow](https://dip.torproject.org/web/tpo/wikis/Git-flow-and-merge-requests#how-to-use-our-git-flow).
 6. Merger should then move the the ticket to the `Closed` column.
 
 ### Reviewer Workflow
 
-1. Review the page on lektor-staging
+1. Review the page on lektor-staging.
 2. Review the content on your repo's develop branch and use the gitlab edit button to make any changes.
 3. When you are happy with your changes:
-    - Update the "Commit message" to explain why you have made your changes
-    - Update the "Target Branch"
+    - Update the "Commit message" to explain why you have made your changes.
+    - Update the "Target Branch".
     - Make sure that the "Start a new merge request with these changes" checkbox is checked.
-    - Click on "Commit changes"
+    - Click on "Commit changes".
 4. You will be sent to a new page to create your merge request:
-    - Update "Title" with a short title to explain your changes
-    - Update "Description", you can use the commit message you entered before additionally referencing the original issue you have reviewed, e.g `https://dip.torproject.org/web/community/issues/3` and tagging one of the repo maintainers e.g `@pili` so they know the change can be merged
+    - Update "Title" with a short title to explain your changes.
+    - Update "Description", you can use the commit message you entered before additionally referencing the original issue you have reviewed, e.g. `https://dip.torproject.org/web/community/issues/3`, and tagging one of the repo maintainers, e.g. `@pili`, so they know the change can be merged.
     - Make sure that both "Delete source branch when merge request is accepted" and "Squash commits when merge request is accepted" are checked.
-    - Click "Submit merge request"
-5. Reviewer should comment on the original issue with a link to the merge request created, e.g `https://dip.torproject.org/steph/community/merge_requests/2`
+    - Click "Submit merge request.
+5. Reviewer should comment on the original issue with a link to the merge request created, e.g. `https://dip.torproject.org/steph/community/merge_requests/2`.
 
 ### Volunteer Workflow
 
@@ -100,13 +99,13 @@ This is the workflow that external volunteers should use when making changes on
 
 We recommend that you use our [github mirror](https://github.com/torproject/community) to submit PRs and contributions to our Community repo. Once you have a PR ready you should:
 
-0. Ideally try to run it locally and check that nothing breaks and everything still behaves as before
-1. Make a PR and ping the team on #tor-www IRC channel to let us know there's a PR waiting for review
+0. Ideally try to run it locally and check that nothing breaks and everything still behaves as before.
+1. Make a PR and ping the team on #tor-www IRC channel to let us know there's a PR waiting for review.
 
 At this point, one of us on the website team will aim to review your PR within 24h during the week (this may take longer on the weekends). Review will involve:
 
-  - Reading the text to make sure it's accurate and there are no spelling errors or grammar mistakes
-  - If there are any front end and/or template changes involved, the changes will be pushed to our `develop` branch for functionality review
+  - Reading the text to make sure it's accurate and there are no spelling errors or grammar mistakes.
+  - If there are any front end and/or template changes involved, the changes will be pushed to our `develop` branch for functionality review.
   - If there are any fixes necessary, we will ask for changes to be made.
 
 Once it all looks good and behaves correctly, we will merge your request to the master branch of the community portal [canonical repo](https://gitweb.torproject.org/project/web/community.git/) on [gitweb](https://gitweb.torproject.org/) master. 



