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 4106adef authored by Georg Koppen's avatar Georg Koppen

Merge remote-tracking branch 'gitlab/merge-requests/28' into maint-1.1

parents 4bed2ce6 bb2a3c61
...@@ -51,26 +51,24 @@ Steps to create a MR ...@@ -51,26 +51,24 @@ Steps to create a MR
Use ``pip install -e <>`` Use ``pip install -e <>``
5. If needed install the documentation and build it as explained in 5. If needed install the documentation and build it as explained in
./DOCUMENTATION.rst ./DOCUMENTATION.rst
6. Create a new branch, named ``ticketXXX``. 6. Create a new feature branch.
Optionally, name it with a string explaining what it does, If the issue solves a bug, base the branch on the latest maintained version,
ie ``ticketXXX_contributing`` eg. ``maint-1.1`` and name it with the name of the base branch plus
``_bugXXX``, where `XXX` is the number of the issue.
If the issue is a new feature, base the branch on the `master` branch and
name it ``ticketXXX``.
Optionally, the last part of the branch name can be any string, eg.
``maint-1.1_bugXXX_contributing``.
7. Write code (:ref:`codestyle-ref`), tests, documentation, 7. Write code (:ref:`codestyle-ref`), tests, documentation,
extra files (:ref:`extrafiles-ref`), commit (:ref:`commits-ref`), etc. extra files (:ref:`extrafiles-ref`), commit (:ref:`commits-ref`), etc.
8. Ensure tests pass (./TESTING.rst). 8. Ensure tests pass (./TESTING.rst).
9. Push your branch to your Gitlab repository. 9. Push your branch to your Gitlab repository.
10. Ensure the CI tests are passing
We are temporally using Github Travis to ensure tests pass. For this: (https://gitlab.torproject.org/tpo/network-health/sbws/-/pipelines)
10. Clone ``sbws`` via the Github web interface:
https://github.com/torproject/sbws
11. Push your branch to your Github repository.
12. If you have an account in Travis, you can see whether it pass the tests in
Github and at https://travis-ci.org/youruser/sbws/
Finally: Finally:
13. Create a MR from your branch at 11. Create a MR from your branch at
https://gitlab.torproject.org/tpo/network-health/sbws https://gitlab.torproject.org/tpo/network-health/sbws
......
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