Skip to content

Commit 3cda147

Browse files
committed
Reference docs added
1 parent 51a0074 commit 3cda147

File tree

7 files changed

+64
-10
lines changed

7 files changed

+64
-10
lines changed

package.json

+6
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
"name": "git-co-commit-docs",
44
"version": "0.1.0",
55
"private": true,
6+
"reactSnapshot": {
7+
"include": [
8+
"/get-started",
9+
"/references"
10+
]
11+
},
612
"dependencies": {
713
"@testing-library/jest-dom": "^4.2.4",
814
"@testing-library/react": "^9.3.2",

public/index.html

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
content="Git co commit: Git pairing with multiple co authors in simple way. Each co-author will be added to the commit message, so that they are also credited in the github contributions view!"
1111
/>
1212
<meta name="keywords" content="Git co commit, git-co-commit, gitpair, pair programming" />
13+
<meta name="google-site-verification" content="dOIPFBjwYFaTDLhU9SiFTo1RAcPAG7SHxa0eSuRZDa8" />
1314
<link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
1415
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
1516
<title>Git Co Commit</title>

src/pages/Docs/Doc7.js

+18-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,24 @@ const Doc7 = () => {
99
<>
1010
<Buttons prevLink="/get-started/setup-git-co-commit-for-node-project" nextLink="/references/dependencies-used" />
1111
<div className={classes.Content}>
12-
<h1>Co authered by in git commit</h1>
12+
<h1 className={classes.Title}>Co authered by in git commit</h1>
13+
<p className={classes.Para}>You can create a commit with more than one author by adding one or more Co-authored-by trailers to the commit's message. Co-authored commits are visible on GitHub and can be included in the profile contributions graph and the repository's statistics.</p>
14+
<h3 className={classes.SubTitle}>Creating co-authored commits on the command line</h3>
15+
<p className={classes.Para}>1. Collect the name and email address for each co-author.</p>
16+
<p className={classes.Para}>2. Type your commit message and a short, meaningful description of your changes. After your commit description, instead of a closing quotation, add two empty lines.</p>
17+
<code className={classes.Code}>
18+
git commit -m "Refactor usability tests <br />
19+
{'>'}<br />
20+
{'>'}<br />
21+
</code>
22+
<p className={classes.Para}>3. On the next line of the commit message, type <span className={classes.SpecialText}>{`Co-authored-by: name <[email protected]>`}</span> with specific information for each co-author. After the co-author information, add a closing quotation mark. If you're adding multiple co-authors, give each co-author their own line and <span className={classes.SpecialText}>Co-authored-by:</span> commit trailer.</p>
23+
<code className={classes.Code}>
24+
git commit -m "Refactor usability tests <br />
25+
{'>'}<br />
26+
{'>'}<br />
27+
Co-authored-by: name {`<[email protected]>`}<br />
28+
Co-authored-by: another-name {'<[email protected]>'}"
29+
</code>
1330
</div>
1431
<Buttons prevLink="/get-started/setup-git-co-commit-for-node-project" nextLink="/references/dependencies-used" />
1532
</>

src/pages/Docs/Doc8.js

+8-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,14 @@ const Doc8 = () => {
99
<>
1010
<Buttons prevLink="/references/co-authered-by-in-git-commit" nextLink="/references/concept-of-git-co-commit" />
1111
<div className={classes.Content}>
12-
<h1>Dependencies used</h1>
12+
<h1 className={classes.Title}>Dependencies used</h1>
13+
<p className={classes.Para}>Git co commit need two npm package and one external npm package which are,</p>
14+
<p className={classes.List}>1. child_process</p>
15+
<p className={classes.List}>2. os</p>
16+
<p className={classes.List}>3. prompt-sync</p>
17+
<p className={classes.Para}><b>child_process:</b> Used to execute the command on different terminals by using JavaScript programming. </p>
18+
<p className={classes.Para}><b>os:</b> Used to check the operating system the program is running.</p>
19+
<p className={classes.Para}><b>prompt-sync:</b> Used to get the input from the user. It is the external npm package we need to install separately. </p>
1320
</div>
1421
<Buttons prevLink="/references/co-authered-by-in-git-commit" nextLink="/references/concept-of-git-co-commit" />
1522
</>

src/pages/Docs/Doc9.js

+13-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,19 @@ const Doc9 = () => {
99
<>
1010
<Buttons prevLink="/references/dependencies-used" />
1111
<div className={classes.Content}>
12-
<h1>Concept of git co commit</h1>
12+
<h1 className={classes.Title}>Concept of git co commit</h1>
13+
<p className={classes.Para}>1. Commit message and co-authors username are getting from the user by using the <b>prompt-sync</b> package. If more than one co-authors, the username must be separated by comma.</p>
14+
<p className={classes.Para}>2. After fetching input from the user, emailId of co-authors are generated <span className={classes.SpecialText}>([email protected])</span>.</p>
15+
<p className={classes.Para}>3. By using the <b>os</b> package, the type of operating system the program is running is fetched.</p>
16+
<p className={classes.Para}>4. Depends upon the operating system, the below git commit command is generated.</p>
17+
<code className={classes.Code}>
18+
git commit -m "Refactor usability tests <br />
19+
{'>'}<br />
20+
{'>'}<br />
21+
Co-authored-by: name {`<[email protected]>`}<br />
22+
Co-authored-by: another-name {'<[email protected]>'}"
23+
</code>
24+
<p className={classes.Para}>5. By using the <b>child_process</b> package, the command is running in the bash or PowerShell based on the operating system.</p>
1325
</div>
1426
<Buttons prevLink="/references/dependencies-used" />
1527
</>

src/pages/Docs/Docs.module.css

+17-6
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
padding: 10px;
1616
}
1717

18-
.Para {
18+
.Para,
19+
.List {
1920
font-size: 18px;
2021
font-weight: lighter;
2122
opacity: 0.95;
@@ -25,22 +26,32 @@
2526
line-height: 28px;
2627
}
2728

28-
.Image {
29+
.List {
30+
text-indent: 30px;
31+
padding: 5px;
32+
line-height: 22px;
33+
}
34+
35+
.SpecialText {
36+
color: blue;
37+
}
38+
39+
.Image,
40+
.LenImage,
41+
.CmdImage {
2942
width: 90%;
3043
max-width: 400px;
3144
margin-left: 5px;
3245
}
3346

34-
.LenImage {
47+
.LenImage,
48+
.CmdImage {
3549
width: 100%;
3650
max-width: 800px;
37-
margin-left: 5px;
3851
}
3952

4053
.CmdImage {
41-
width: 100%;
4254
max-width: 500px;
43-
margin-left: 5px;
4455
}
4556

4657
.ImageBorder {

src/pages/Home/Body1/Body1.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const Body1 = () => {
1212
<p className={classes.Para}>Install git-co-commit package to use just a single commit to add all the team members that worked in the project as co-authors.</p>
1313
<div className={classes.Btns}>
1414
<Link to='/get-started' className={[classes.Btn, classes.Start].join(' ')}>Get started</Link>
15-
<Link to='/' className={[classes.Btn, classes.Download].join(' ')}>Download</Link>
15+
<Link to='/get-started/installing-using-git-co-commit' className={[classes.Btn, classes.Download].join(' ')}>Download</Link>
1616
</div>
1717
</div>
1818
<div className={classes.Image}>

0 commit comments

Comments
 (0)