Skip to content

Commit ce248b9

Browse files
committed
-Formatted <ul> tags
-Added image: "CYF-Git-Branch-Example.png" "Git Branches" article: -Deleted default <p> text; added explanation of Git Branches -Added hyperlink to "Read more" <a> tag
1 parent f3e355a commit ce248b9

2 files changed

Lines changed: 33 additions & 4 deletions

File tree

42.4 KB
Loading

Wireframe/index.html

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,17 @@ <h2>README</h2>
3636
This may include things such as:
3737

3838
<ul>installation instructions</ul>
39+
3940
<ul>Version info</ul>
41+
4042
<ul>System requirements</ul>
43+
4144
<ul>A basic description of the software</ul>
45+
4246
<ul>Troubleshooting and support contact info</ul>
47+
4348
<ul>Copyright and licensing info</ul>
49+
4450
<ul>Source links</ul>
4551

4652
README files are commonly written in Markdown (.md) plaintext format.
@@ -51,13 +57,36 @@ <h2>README</h2>
5157

5258
<main>
5359
<article>
54-
<img src="placeholder.svg" alt="" />
60+
<img src="CYF-Git-Branch-Example.png" alt="Picture of CYF Example Git Branch Diagram" />
5561
<h2>Git Branches</h2>
5662
<p>
57-
Lorem ipsum dolor sit amet consectetur adipisicing elit. Quisquam,
58-
voluptates. Quisquam, voluptates.
63+
64+
<ul>In Git, repositories take the form of "branches."</ul>
65+
66+
<ul>The default branch is called "main" - this represents the original code, developmental history and
67+
final version of a project.</ul>
68+
69+
<ul>Branches create a copy off of "main" to work on specific issues or parts of a project in isolation.</ul>
70+
71+
<ul>Individual edits made and saved to a repository are called "commits."</ul>
72+
73+
<ul>Essentially, a "branch" is a specific sequence of "commits" representing a specific version of a project.</ul>
74+
75+
<ul>Once finalised, a branch can be merged with the "main" via a "Pull Request"</ul>
76+
77+
<br>
78+
79+
Branches themselves can also be branched. This allows edits and issues to be specified even further.
80+
81+
<br>
82+
83+
As an example: A user is working on their own branch of a project and identifies issues with two specific areas of code,
84+
but the rest of the project is otherwise fine. Individual branches could be created to focus on addressing these problems
85+
separately, without worry of accidentally making any drastic changes to the overall project.
86+
5987
</p>
60-
<a href="https://www.makeareadme.com/">Read more</a>
88+
<a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches">
89+
Read more</a>
6190
</article>
6291
</main>
6392
<footer>

0 commit comments

Comments
 (0)