commit 10d21d7d6bba9b919b2baf84e3d86e8f2c0e609f Author: Pili Guerra pili@piliguerra.com Date: Wed Sep 18 22:03:33 2019 +0200
Update README with our workflow --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+)
diff --git a/README.md b/README.md index d543c35..cf1d9de 100644 --- a/README.md +++ b/README.md @@ -61,3 +61,38 @@ To help us to translate, please join the Tor Project team in [Transifex](https:/ ### 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). + +## Our Workflows + +### 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-...) 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) +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... + - 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/%7Buser%7D/community/blob/master/content/onion-se... +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-...) +7. Merger should then move the the ticket to the `Closed` column + +### Volunteer Workflow + +This is the workflow that external volunteers should use when making changes on the Community Portal: + +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 + +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 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. +