Skip to content

Commit b30c1fa

Browse files
authored
Merge pull request #22299 from LasseRosenow/fix-contributing-guide
CONTRIBUTING.md: Remove $ characters in code blocks
2 parents d781d86 + 4f051d9 commit b30c1fa

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

CONTRIBUTING.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ It is possible to check if your code follows these conventions:
109109
* You can [uncrustify] `.c` and `.h` files:
110110

111111
```console
112-
$ uncrustify -c $RIOTBASE/uncrustify-riot.cfg --no-backup <your file>
112+
uncrustify -c $RIOTBASE/uncrustify-riot.cfg --no-backup <your file>
113113
```
114114

115115
**Note**: The `--no-backup` flag makes uncrustify *replace* the current file
@@ -123,7 +123,7 @@ It is possible to check if your code follows these conventions:
123123
so make sure they can be rebased (e.g. there's no potential conflict).
124124

125125
```console
126-
$ make static-test
126+
make static-test
127127
```
128128

129129
Use it before opening a PR to perform last time checks.
@@ -224,7 +224,7 @@ To generate the documentation, simply run the following
224224
from the base directory of the RIOT source code.
225225

226226
```console
227-
$ make doc
227+
make doc
228228
```
229229

230230
The generated documentation is located in `doc/doxygen/html`
@@ -251,23 +251,23 @@ from the [RIOT main GitHub page][riot-github].
251251
If it's your first time with git, configure your name and emails:
252252

253253
```console
254-
$ git config --global user.name = "<your name here>"
255-
$ git config --global user.email = "<your email address here>"
254+
git config --global user.name = "<your name here>"
255+
git config --global user.email = "<your email address here>"
256256
```
257257

258258
Then clone locally your fork of RIOT (replace `account name` with your actual
259259
login on GitHub):
260260

261261
```console
262-
$ git clone git@github.com:<account name>/RIOT.git
262+
git clone git@github.com:<account name>/RIOT.git
263263
```
264264

265265
You can keep any branch of your local repository up-to-date with the upstream
266266
master branch with the following commands:
267267

268268
```console
269-
$ git checkout <branch name>
270-
$ git pull --rebase https://github.com/RIOT-OS/RIOT.git
269+
git checkout <branch name>
270+
git pull --rebase https://github.com/RIOT-OS/RIOT.git
271271
```
272272

273273
Use it before opening a PR. This will at least ensure the PR is mergeable but
@@ -282,16 +282,16 @@ the RIOT upstream repository: update your master branch and start a new branch
282282
from it.
283283

284284
```console
285-
$ git checkout master
286-
$ git pull --rebase https://github.com/RIOT-OS/RIOT.git
287-
$ git checkout -b <new branch>
285+
git checkout master
286+
git pull --rebase https://github.com/RIOT-OS/RIOT.git
287+
git checkout -b <new branch>
288288
```
289289

290290
You can then do your changes, commit them and push them to your local repository
291291
by using the following command:
292292

293293
```console
294-
$ git push origin <your branch>
294+
git push origin <your branch>
295295
```
296296

297297
### Add fixup commits during review
@@ -306,8 +306,8 @@ Instead of committing changes in `prefix2` in a 4th commit `prefix2: change 4`,
306306
you can use the `--fixup` option:
307307

308308
```console
309-
$ git add /path/of/prefix2
310-
$ git commit --fixup <prefix2 commit hash>
309+
git add /path/of/prefix2
310+
git commit --fixup <prefix2 commit hash>
311311
```
312312

313313
### Squash commits after review
@@ -345,7 +345,7 @@ If you used [fixup commits](#add-fixup-commits-during-review) during the review
345345
phase, squashing commits can be performed in a single command:
346346

347347
```console
348-
$ git rebase -i --autosquash <last master hash>
348+
git rebase -i --autosquash <last master hash>
349349
```
350350

351351
If you encounter a merge conflict, it is generally easiest to use a merge tool
@@ -355,14 +355,14 @@ or IDE.
355355
After the merge conflict is resolved you can continue the rebase by using
356356

357357
```console
358-
$ git rebase --continue
358+
git rebase --continue
359359
```
360360

361361
Once squashing is done, you will have to force push your branch to update the
362362
PR:
363363

364364
```console
365-
$ git push origin <your branch> --force-with-lease
365+
git push origin <your branch> --force-with-lease
366366
```
367367

368368
### Manually rebasing
@@ -390,7 +390,7 @@ You then have to force push your updated branch to the remote repository by
390390
using the following command:
391391

392392
```console
393-
$ git push origin <your branch> --force-with-lease
393+
git push origin <your branch> --force-with-lease
394394
```
395395

396396
## Mediating Conflicts

0 commit comments

Comments
 (0)