diff --git a/doc/development.rst b/doc/development.rst index 7566f7b903b1bd6f82ba398948829e440bf05ddc..354ee9a2cb19990da2b6adb82c700a84914184bf 100644 --- a/doc/development.rst +++ b/doc/development.rst @@ -5,8 +5,8 @@ Development =========== -Development of Mutalyzer happens on GitLab: -https://git.lumc.nl/mutalyzer/mutalyzer +Development of Mutalyzer happens on GitHub: +https://github.com/LUMC/mutalyzer Contributing @@ -53,21 +53,23 @@ Working with feature branches New features are best implemented in their own branches, isolating the work from unrelated developments. In fact, it's good practice to *never work -directly on the master branch* but always in a separate branch. For this -reason, the master branch on the GitLab server is locked. Feature branches can -be merged back into master via a *merge request* in GitLab. +directly on the master branch* but always in a separate branch. When your work +is ready, a feature branch can be merged back into master via a *pull request* +in GitHub. -Before starting work on your feature, create a branch for it:: +We assume you forked the Mutalyzer repository to your own namespace in GitHub +and are working from this fork. Before starting work on your feature, create a +branch for it:: git checkout -b your-feature -Commit changes on this branch. If you're happy with it, push to GitLab:: +Commit changes on this branch. If you're happy with it, push to GitHub:: git push origin your-feature -u -Now create a merge request to discuss the implementation with your -colleagues. This might involve adding additional commits which are included in -the merge request by pushing your branch again:: +Now create a pull request to discuss the implementation with the Mutalyzer +maintainers. This might involve adding additional commits which are included +in the pull request by pushing your branch again:: git commit git push @@ -79,7 +81,7 @@ changed since you started your work. This will require a forced push:: git rebase origin/master git push -f -If the work is done, a developer can merge your branch and close the merge +If the work is done, a maintainer can merge your branch and close the pull request. After the branch was merged you can safely delete it:: git branch -d your-feature @@ -98,7 +100,7 @@ require X.Y.Z-dev instead of X.Y.Z.dev but `compatibility with setuptools is more important for us. Other than that, version semantics are as described by SemVer. -Releases are available from the GitLab git repository as tags. Additionally, +Releases are available from the GitHub git repository as tags. Additionally, the latest release is available from the `release` branch. .. note:: Older Mutalyzer version numbers took the form 2.0.beta-X where X was @@ -127,11 +129,11 @@ Releasing a new version is done as follows: git commit -am 'Bump version to X.Y.Z' git tag -a 'vX.Y.Z' -3. Push to the GitLab repository (assuming the remote name is `gitlab` and you +3. Push to the GitHub repository (assuming the remote name is `github` and you are working on the `master` branch:: - git push gitlab master - git push gitlab master:release --tags + git push github master + git push github master:release --tags 4. Add a new entry at the top of the ``CHANGES`` file like this:: diff --git a/doc/download.rst b/doc/download.rst index d1a685684ff17efdb6373e40853369ce1d496894..7a8f3bd081392d9f218f8a55e0ff125cb033a88a 100644 --- a/doc/download.rst +++ b/doc/download.rst @@ -5,11 +5,11 @@ Downloading Mutalyzer ===================== -The Mutalyzer source code is `hosted on the LUMC GitLab server -<https://git.lumc.nl/mutalyzer/mutalyzer>`_. The recommended way to get the +The Mutalyzer source code is `hosted on GitHub +<https://github.com/LUMC/mutalyzer>`_. The recommended way to get the Mutalyzer source code is by cloning the `Git`_ repository:: - git clone https://git.lumc.nl/mutalyzer/mutalyzer.git + git clone https://github.com/LUMC/mutalyzer.git This will give you the current development version. See below for working with other versions. @@ -34,9 +34,9 @@ Archive downloads If for whatever reason you don't want to use Git, you can download the source code directly as a zip archive or tarball. The current development version can be found from the `project homepage -<https://git.lumc.nl/mutalyzer/mutalyzer>`_. Archive downloads for release -versions can be found on the `tags page -<https://git.lumc.nl/mutalyzer/mutalyzer/tags>`_. +<https://github.com/LUMC/mutalyzer>`_. Archive downloads for release versions +can be found on the `releases page +<https://github.com/LUMC/mutalyzer/releases>`_. .. _Git: http://git-scm.com/ diff --git a/doc/issues.rst b/doc/issues.rst index 53d116d800dad991be5b26b16e556a82ef8b2195..18d350acbf463f2996ec78952bdb9a4fcd36b6b8 100644 --- a/doc/issues.rst +++ b/doc/issues.rst @@ -5,13 +5,13 @@ For historical reasons, we currently have two issue trackers: 1. `Mutalyzer Trac -- Active tickets <https://humgenprojects.lumc.nl/trac/mutalyzer/report/2>`_ -2. `Mutalyzer GitLab -- Open issues - <https://git.lumc.nl/mutalyzer/mutalyzer/issues>`_ +2. `Mutalyzer GitHub -- Issues + <https://github.com/LUMC/mutalyzer/issues>`_ The first, on the Mutalyzer Trac website, is the advertised location for end users to report issues. This is also where most feature requests are tracked. -The second, on the Mutalyzer GitLab project site, is mainly for +The second, on the Mutalyzer GitHub project site, is mainly for developers. Most issues here are of infrastructural or technical nature. In addition to these issue lists, smaller and more specific notes can be found diff --git a/mutalyzer/website/templates/base.html b/mutalyzer/website/templates/base.html index c7088e2e030f09c771e0dab3bbe1cbcd851da5a7..bb4f763296b7d440e7a8e6be6a0ee2fa5a6f3eac 100644 --- a/mutalyzer/website/templates/base.html +++ b/mutalyzer/website/templates/base.html @@ -121,7 +121,7 @@ <a href="https://humgenprojects.lumc.nl/trac/mutalyzer" target="new">Feedback</a> </li> <li> - <a href="https://git.lumc.nl/mutalyzer/mutalyzer" target="new">Source code</a> + <a href="https://github.com/LUMC/mutalyzer" target="new">Source code</a> </li> </ul> </li>