Skip to content

Commit bb553ce

Browse files
committed
Checked improved contributing.md
Changes made on github have been checked, added quick git cheatsheet for 'local'
1 parent 7b4b03f commit bb553ce

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

doc/contributing.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,17 @@ Here's a short guidelines on how to do so.
66

77

88
## Submit an issue (no git/github skills required)
9-
Open an issue from [here](https://github.com/cpp-lln-lab/CPP_LabGuide/issues/new/choose) and try to be the most detailed possible.
109

10+
Open an issue from [here](https://github.com/cpp-lln-lab/CPP_LabGuide/issues/new/choose) and try to be the most detailed possible.
1111
Try to be the most detailed possible, so it's easier to intervene.
1212

13-
The actual text/scripts you find in this website are in this [repo](https://github.com/cpp-lln-lab/CPP_LabGuide) and in the `doc` folder [here](https://github.com/cpp-lln-lab/CPP_LabGuide/tree/main/doc)
1413

1514
## Make the changes yourself (minor git/github skills required)
1615

17-
The actual text/scripts you find in this website are in this [repoistory](https://github.com/cpp-lln-lab/CPP_HPC) and in the `/doc` folder [here](https://github.com/cpp-lln-lab/CPP_HPC/tree/main/doc)
16+
The actual text/scripts you find in this website are in this [repoistory](https://github.com/cpp-lln-lab/CPP_LabGuide) and in the `/doc` folder [here](https://github.com/cpp-lln-lab/CPP_HPC/tree/main/doc).
1817
Each article/section of the website is a specific markdown (`.md`) file with (more or less) the same transparent name.
1918

20-
If you're new to markdown, here's a quick [cheatsheet](https://www.markdownguide.org/cheat-sheet/).
19+
If you're new to markdown, here's a quick [markdown cheatsheet](https://www.markdownguide.org/cheat-sheet/).
2120

2221

2322
### Edit from github
@@ -34,6 +33,8 @@ To change the website structure (add, reorder, rename sections), see the file `m
3433

3534
### Edit locally
3635

36+
If you're unfamiliar with the terms used here, check out the [git cheatsheet](https://training.github.com/downloads/github-git-cheat-sheet/)
37+
3738
1. fork this repository
3839
2. clone your forked repository
3940
3. install the dependencies via:

0 commit comments

Comments
 (0)