Skip to content

Commit

Permalink
Fix urls in contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mlaux1 committed Dec 3, 2024
1 parent 9d1c02b commit 2412b69
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Everyone is welcome to contribute.
There are several ways to contribute to DeformableGym: you could

* send a bug report to the
[bug tracker](https://git.hb.dfki.de/april/learning/deformable_gym)
[issue tracker](https://www.github.com/dfki-ric/deformable_gym)
* work on one of the reported issues
* write documentation
* add a new feature
Expand All @@ -18,17 +18,17 @@ This text is shamelessly copied from
[scikit-learn's](https://scikit-learn.org/stable/developers/contributing.html)
contribution guidelines.

The preferred way to contribute to DefromableGym is to fork the
[repository](https://git.hb.dfki.de/april/learning/deformable_gym) on GitLab,
then submit a "merge request" (MR):
The preferred way to contribute to DefromableGym is to fork this
[repository](https://www.github.com/dfki-ric/deformable_gym),
then submit a "pull request" (PR):

1. Fork the [project repository](https://git.hb.dfki.de/april/learning/deformable_gym):
1. Fork the [project repository](https://www.github.com/dfki-ric/deformable_gym):
click on the 'Fork' button near the top of the page. This creates a copy of
the code under your account on the GitHub server.

2. Clone this copy to your local disk:

$ git clone --recurse-submodules git@git.hb.dfki.de:april/learning/deformable_gym.git
$ git clone git@github.com:dfki-ric/deformable_gym.git

3. Create a branch to hold your changes:

Expand All @@ -47,16 +47,16 @@ then submit a "merge request" (MR):
$ git push -u origin my-feature

Finally, go to the web page of your fork of the deformable_gym repository,
and click 'Merge request' to send your changes to the maintainer for review.
Make sure that your target branch is 'development'.
and click 'Pull request' to send your changes to the maintainer for review.
Make sure that your target branch is `development`.

In the above setup, your `origin` remote repository points to
YourLogin/deformable_gym.git. If you wish to fetch/merge from the main
repository instead of your forked one, you will need to add another remote
to use instead of `origin`. If we choose the name `upstream` for it, the
command will be:

$ git remote add upstream https://git.hb.dfki.de/april/learning/deformable_gym
$ git remote add upstream https://www.github.com/dfki-ric/deformable_gym

(If any of the above seems like magic to you, then look up the
[Git documentation](http://git-scm.com/documentation) on the web.)
Expand Down Expand Up @@ -89,4 +89,4 @@ be discussed and announced in advance with deprecation warnings.
Semantic versioning is used, that is, the major version number will be
incremented when the API changes in a backwards incompatible way, the
minor version will be incremented when new functionality is added in a
backwards compatible manner.
backwards compatible manner.

0 comments on commit 2412b69

Please sign in to comment.