Slug.Boi/cocommit
1
0
Fork 0
mirror of https://github.com/Slug-Boi/cocommit.git synced 2026-05-13 12:45:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md updated syntax for author file

Browse Source
This commit is contained in:
Theis
2024-03-04 23:19:48 +01:00
committed by GitHub
parent d84d64434f
commit 238cc75579
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -2
View File
@@ -35,10 +35,12 @@ $ cocommit users
``` ```
# Syntax for the author file # Syntax for the author file
The syntax for the author file can be found at the top of the template file included in the repo. It should look like this: The syntax for the author file can be found at the top of the template file included in the repo. It should look like this (opt) is optional syntax:
``` ```
name_short|Name|Username|email name_short|Name|Username|email (opt: |ex)
``` ```
opt explained:
ex -> excludes the given author for all and negation commands
# Why? # Why?
Writing co-authors onto commits can be pretty tedious so automating this process as a simple shell alias is a lot nicer Writing co-authors onto commits can be pretty tedious so automating this process as a simple shell alias is a lot nicer