Skip to content

Commit d505948

Browse files
committed
Document the forking steps
1 parent c55c6e0 commit d505948

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.adoc

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,29 @@
11
= Code Description
22

3-
An example of a flawed C++ code. It is meant to be compiled with different build systems using different CI pipelines on Linux, MacOS, and Windows.
3+
An example of a flawed C++ code. The https://github.com/sc-sq-c-family-examples/code[code repository] is meant to be compiled with different build systems using different CI pipelines on Linux, MacOS, and Windows.
44

5-
This repository is forked into other repositories in https://github.com/sc-sq-c-family-examples[this collection] to add a specific build system, platform, and CI.
5+
The https://github.com/sc-sq-c-family-examples/code[code repository] is forked into other repositories in https://github.com/sc-sq-c-family-examples[this collection] to add a specific build system, platform, and CI.
66
The downstream repositories are analyzed either with https://www.sonarqube.org/[SonarQube] or https://sonarcloud.io/[SonarCloud].
7+
8+
== Forking the code repository
9+
Since GitHub disallows forking of a repository within the same organization, here is the equivalent in `git` commands (on the example of `linux-cmake-gh-actions`):
10+
11+
Clone the newly created repository:
12+
----
13+
git clone gh:sc-sq-c-family-examples/linux-cmake-gh-actions
14+
cd linux-cmake-gh-actions
15+
----
16+
Add the https://github.com/sc-sq-c-family-examples/code[code repository] as a second remote named `code`:
17+
----
18+
git remote add code git@github.com:sc-sq-c-family-examples/code
19+
----
20+
Get the code:
21+
----
22+
git pull code master
23+
----
24+
If the contents of the https://github.com/sc-sq-c-family-examples/code[code repository] changes, you can pull the changes with the last command.
25+
26+
Push the changes to the custom repository:
27+
----
28+
git push origin master
29+
----

0 commit comments

Comments
 (0)