GitLab is used only for code review, issue tracking and project management. Canonical locations for source code are still https://gitweb.torproject.org/ https://git.torproject.org/ and git-rw.torproject.org.

Commit af6c6ecb authored by Hiro's avatar Hiro 🏄

Change readme

parent f8716df3
......@@ -68,14 +68,14 @@ 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/dev/-/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/dev/-/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://gitlab.torproject.org/web/dev/-/boards). You can follow the process outlined in ["How to send a merge request or propose a change"](https://gitlab.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://gitlab.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://gitlab.torproject.org/web/dev/-/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/dev/develop/
- Contents file, containing your changes where it would be located on the **reviewer's repo** e.g `https://dip.torproject.org/steph/dev/blob/develop/content/onion-services/contents.lr`
- Contents file, containing your changes where it would be located on the **reviewer's repo** e.g `https://gitlab.torproject.org/steph/dev/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)
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://gitlab.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
......@@ -89,10 +89,10 @@ This is the workflow that Tor Internal people should use when making changes on
- 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/dev/issues/3` and tagging one of the repo maintainers e.g `@pili` so they know the change can be merged
- Update "Description", you can use the commit message you entered before additionally referencing the original issue you have reviewed, e.g `https://gitlab.torproject.org/web/dev/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/dev/merge_requests/2`
5. Reviewer should comment on the original issue with a link to the merge request created, e.g `https://gitlab.torproject.org/steph/dev/merge_requests/2`
### Volunteer Workflow
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment