Commit 2c8b21cc authored by Loïck Bonniot's avatar Loïck Bonniot

[minor] Update CONTRIBUTING.md

parent b22dadec
Pipeline #96 passed with stage
...@@ -120,28 +120,28 @@ project: ...@@ -120,28 +120,28 @@ project:
1. Fork the project, clone your fork, 1. Fork the project, clone your fork,
and configure the remotes: and configure the remotes:
```bash ```bash
# Clone your fork of the repo into the current directory # Clone your fork of the repo into the current directory
git clone https://gitlab.insa-rennes.fr/<your-username>/<repo-name> git clone https://gitlab.insa-rennes.fr/<your-username>/<repo-name>
# Navigate to the newly cloned directory # Navigate to the newly cloned directory
cd <repo-name> cd <repo-name>
# Assign the original repo to a remote called "upstream" # Assign the original repo to a remote called "upstream"
git remote add upstream https://gitlab.insa-rennes.fr/mpcs/dfss git remote add upstream https://gitlab.insa-rennes.fr/mpcs/dfss
``` ```
2. If you cloned a while ago, get the latest changes from upstream: 2. If you cloned a while ago, get the latest changes from upstream:
```bash ```bash
git checkout <dev-branch> git checkout <dev-branch>
git pull upstream <dev-branch> git pull upstream <dev-branch>
``` ```
3. Create a new topic branch (off the main project development branch) to 3. Create a new topic branch (off the main project development branch) to
contain your feature, change, or fix: contain your feature, change, or fix:
```bash ```bash
git checkout -b <topic-branch-name> git checkout -b <topic-branch-name>
``` ```
4. Commit your changes in logical chunks. Please adhere to these [git commit 4. Commit your changes in logical chunks. Please adhere to these [git commit
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
...@@ -153,15 +153,15 @@ project: ...@@ -153,15 +153,15 @@ project:
5. Locally merge (or rebase) the upstream development branch into your topic branch: 5. Locally merge (or rebase) the upstream development branch into your topic branch:
```bash ```bash
git pull [--rebase] upstream <dev-branch> git pull [--rebase] upstream <dev-branch>
``` ```
6. Push your topic branch up to your fork: 6. Push your topic branch up to your fork:
```bash ```bash
git push origin <topic-branch-name> git push origin <topic-branch-name>
``` ```
7. Open a Pull Request with a clear title and description. 7. Open a Pull Request with a clear title and description.
......
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