Skip to content

Commit 11e1794

Browse files
authored
Update CONTRIBUTING.md
Move git flow to the top
1 parent 4413810 commit 11e1794

File tree

1 file changed

+47
-45
lines changed

1 file changed

+47
-45
lines changed

week-1/CONTRIBUTING.md

+47-45
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,8 @@
11
# Git & Github
22

3-
## Best practises for committing on Github.
4-
5-
#### How often to commit?
6-
7-
In order to determine how frequently you should commit, it is advised to follow this general guide:
8-
9-
- Think of something that needs to be fixed.
10-
- Do the work!
11-
- Test it works
12-
- Add and commit
13-
14-
If you are in ever in doubt, commit early and often :)
15-
16-
17-
#### Two ways to make write a commit message.
18-
19-
`git commit -m <commit message>`
20-
21-
- writes one line of commit message and commits all in one go
22-
23-
` git commit `
24-
25-
- opens your default command-line text editor, which is good for writing longer commit messages (see below for formatting guideline).
26-
27-
- if using vim text editor, once you have finished your commit message, you need to hit esc and then ‘:wq’ + enter to close text editor.
28-
29-
#### Seven tips to format the perfect commit message
30-
31-
- Separate subject from body with a blank line
32-
- Limit the subject line to 50 characters
33-
- Capitalize the subject line
34-
- Do not end the subject line with a period
35-
- Use the imperative mood in the subject line
36-
- Wrap the body at 72 characters
37-
- Use the body to explain what and why (and how does it address the issue), and usually not how
38-
39-
Top tips:
40-
~/.vimrc tells vim to wrap your text at 72 chars and spell checks
3+
##Git flow
414

42-
43-
Useful links
44-
https://chris.beams.io/posts/git-commit/
45-
46-
#Git flow
47-
48-
##Standard Procedure:
5+
###Standard Procedure:
496

507
1. Initialise your repo on Github (skip if cloning an existing repo), ensuring you initialise with a Readme.MD file.
518

@@ -112,6 +69,51 @@ https://chris.beams.io/posts/git-commit/
11269

11370
When a branch is deleted on the remote, it won't delete on your local, even after you next pull from the remote.
11471

72+
-----
73+
74+
## Best practises for committing on Github.
75+
76+
#### How often to commit?
77+
78+
In order to determine how frequently you should commit, it is advised to follow this general guide:
79+
80+
- Think of something that needs to be fixed.
81+
- Do the work!
82+
- Test it works
83+
- Add and commit
84+
85+
If you are in ever in doubt, commit early and often :)
86+
87+
88+
#### Two ways to make write a commit message.
89+
90+
`git commit -m <commit message>`
91+
92+
- writes one line of commit message and commits all in one go
93+
94+
` git commit `
95+
96+
- opens your default command-line text editor, which is good for writing longer commit messages (see below for formatting guideline).
97+
98+
- if using vim text editor, once you have finished your commit message, you need to hit esc and then ‘:wq’ + enter to close text editor.
99+
100+
#### Seven tips to format the perfect commit message
101+
102+
- Separate subject from body with a blank line
103+
- Limit the subject line to 50 characters
104+
- Capitalize the subject line
105+
- Do not end the subject line with a period
106+
- Use the imperative mood in the subject line
107+
- Wrap the body at 72 characters
108+
- Use the body to explain what and why (and how does it address the issue), and usually not how
109+
110+
Top tips:
111+
~/.vimrc tells vim to wrap your text at 72 chars and spell checks
112+
113+
114+
Useful links
115+
https://chris.beams.io/posts/git-commit/
116+
115117

116118
PULL REQUESTS BEST PRACTISE
117119

0 commit comments

Comments
 (0)