Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
mutalyzer
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Analyze
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Mirrors
mutalyzer
Commits
6d7b825c
Commit
6d7b825c
authored
10 years ago
by
Vermaat
Browse files
Options
Downloads
Patches
Plain Diff
Update documentation for GitLab->GitHub move
parent
df781fe9
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
doc/development.rst
+17
-15
17 additions, 15 deletions
doc/development.rst
doc/download.rst
+6
-6
6 additions, 6 deletions
doc/download.rst
doc/issues.rst
+3
-3
3 additions, 3 deletions
doc/issues.rst
mutalyzer/website/templates/base.html
+1
-1
1 addition, 1 deletion
mutalyzer/website/templates/base.html
with
27 additions
and
25 deletions
doc/development.rst
+
17
−
15
View file @
6d7b825c
...
...
@@ -5,8 +5,8 @@
Development
===========
Development of Mutalyzer happens on Git
La
b:
https://git
.lumc.nl/mutalyzer
/mutalyzer
Development of Mutalyzer happens on Git
Hu
b:
https://git
hub.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 Git
La
b.
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 Git
Hu
b.
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 Git
La
b::
Commit changes on this branch. If you're happy with it, push to Git
Hu
b::
git push origin your-feature -u
Now create a
merge
request to discuss the implementation with
you
r
colleague
s. 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 Mutalyze
r
maintainer
s. 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
develop
er can merge your branch and close the
merge
If the work is done, a
maintain
er 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 Git
La
b git repository as tags. Additionally,
Releases are available from the Git
Hu
b 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 Git
La
b repository (assuming the remote name is `git
la
b` and you
3. Push to the Git
Hu
b repository (assuming the remote name is `git
hu
b` and you
are working on the `master` branch::
git push git
la
b master
git push git
la
b master:release --tags
git push git
hu
b master
git push git
hu
b master:release --tags
4. Add a new entry at the top of the ``CHANGES`` file like this::
...
...
This diff is collapsed.
Click to expand it.
doc/download.rst
+
6
−
6
View file @
6d7b825c
...
...
@@ -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://git
hub.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://git
hub.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 `
tag
s page
<https://git
.lumc.nl/mutalyzer/mutalyzer/tag
s>`_.
<https://git
hub.com/LUMC
/mutalyzer>`_. Archive downloads for release
versions
can be found on the `
release
s page
<https://git
hub.com/LUMC/mutalyzer/release
s>`_.
.. _Git: http://git-scm.com/
This diff is collapsed.
Click to expand it.
doc/issues.rst
+
3
−
3
View file @
6d7b825c
...
...
@@ -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 Git
La
b --
Open i
ssues
<https://git
.lumc.nl/mutalyzer
/mutalyzer/issues>`_
2. `Mutalyzer Git
Hu
b --
I
ssues
<https://git
hub.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 Git
La
b project site, is mainly for
The second, on the Mutalyzer Git
Hu
b 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
...
...
This diff is collapsed.
Click to expand it.
mutalyzer/website/templates/base.html
+
1
−
1
View file @
6d7b825c
...
...
@@ -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://git
hub.com/LUMC
/mutalyzer"
target=
"new"
>
Source code
</a>
</li>
</ul>
</li>
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment