Update README with Cdez's Standards
+- Update README with Cdez's Standards for Committing Signed-off-by: cdez <cdez@cdezselfhosted.pw>
This commit is contained in:
parent
138b4784c1
commit
837dcc0fc5
1 changed files with 19 additions and 1 deletions
18
README.md
18
README.md
|
|
@ -1,3 +1,21 @@
|
||||||
# CS136-Projects
|
# CS136-Projects
|
||||||
|
|
||||||
All my CS136 stuff.
|
All my CS136 stuff.
|
||||||
|
|
||||||
|
## Cdez's Standards for Committing
|
||||||
|
### Standard 1:
|
||||||
|
Use "++" in the extended description to show what was added, either generally, or specifically.
|
||||||
|
Use "+-" in the extended description to show what was modified/changed, either generally, or specifically.
|
||||||
|
Use "--" in the extended description to show what was removed, either generally, or specifically.
|
||||||
|
### Standard 2:
|
||||||
|
The description will have the biggest changes listed, in the order of biggest to smallest differences.
|
||||||
|
### Standard 3:
|
||||||
|
If committing to main, make sure to have all the above standards in order before committing.
|
||||||
|
### Standard 4:
|
||||||
|
Pull Requests:
|
||||||
|
#### Standard 4.1:
|
||||||
|
Create a new working branch from main. (Or you may use the 'Create a new branch GitWeb function.')
|
||||||
|
#### Standard 4.2:
|
||||||
|
Call the branch the biggest change of the branch, using Standard 1 in it's name with the biggest change/addition/removal.
|
||||||
|
#### Standard 4.3:
|
||||||
|
When done with the branch, merge into main, and make sure to have very detailed descriptions.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue