[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
[tor-commits] [community/master] Update Workflows
commit 640f299baa6b40201bd97d0a9b0e8d6aa739ca6a
Author: Pili Guerra <pili@xxxxxxxxxxxxxx>
Date: Fri Sep 20 12:12:52 2019 +0200
Update Workflows
---
README.md | 49 +++++++++++++++++++++++++++++++++++++------------
1 file changed, 37 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index cf1d9de..1bc2893 100644
--- a/README.md
+++ b/README.md
@@ -64,20 +64,45 @@ If you want to contribute to the Community portal, we will be happy to help you.
## Our Workflows
-### Internal Workflow
+### Tor Internal Workflow
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 either run lektor locally, or push to `develop` branch.
-3. Once you are happy with your work, push your changes to `staging` branch and move to `needs-review` column on the [Community Portal Project Board](https://dip.torproject.org/web/community/-/boards)
+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. e.g
+```
+# Start a new feature
+git checkout -b new-feature master
+# Edit some files
+git add <file>
+git commit -m "Start a feature"
+# Edit some files
+git add <file>
+git commit -m "Finish a feature"
+```
+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, e.g https://lektor-staging.torproject.org/community/staging/
- - Contents file, on your branch, containing your changes, e.g https://dip.torproject.org/pili/community/blob/master/content/onion-services/contents.lr
- - For the review workflow, please see
-5. Once the work has been reviewed and any necessary changes have been made, reviewer should move the issue to the `reviewed` column and add a comment to the issue with details of where the latest version can be found, e.g https://dip.torproject.org/{user}/community/blob/master/content/onion-services/contents.lr
-6. Team members with write access to gitweb master will then push 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)
-7. Merger should then move the the ticket to the `Closed` column
+ - 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
+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"
+ - Make sure that the "Start a new merge request with these changes" checkbox is checked.
+ - 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
+ - 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`
### Volunteer Workflow
@@ -86,12 +111,12 @@ 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 reviewx
+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 development branch for functionality review
+ - 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.
_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits