Template:Cite GitHub/doc: Difference between revisions

Latest revision as of 21:44, 14 September 2024

Cite GitHub.

Use this to Cite GitHub.

Cites a GitHub commit or file.

Template parameters
Parameter		Description	Type	Status
URL	`url`	The URL to the resource. Example https://github.com/Chew/MLB-GameFeed-Bot/blob/875f62c510ba9703ccbe2d285d046930372203ba/src/main/java/pw/chew/mlb/MLBBot.java	URL	required
Title	`title`	The title of the file, commit, etc. Example MLBBot.java	String	required
Author	`author`	The author of the commit, if applicable.	String	optional
Org/User	`org`	Org/User of Repo Example The organization, or username, of the user/company who owns the repository linked.	String	required
Repository Name	`repo`	The name of the repository being cited. Example chew.pw	String	required
Type	`type`	The type of thing being cited. Currently just a commit or file. Suggested values `commit` `file`	String	required
Commit Hash	`commit`	The hash of the commit being referenced. Only required if the type is a commit.	String	required
Retrieved Date	`retrieved`	The date the file was retrieved. Not necessary if referencing a hash.	Date	suggested
Commit Date	`date`	The day the commit was committed.	Date	optional

@@ Line 51: / Line 51: @@
 			"required": true
 		},
-		"hash": {
+		"retrieved": {
+			"label": "Retrieved Date",
+			"description": "The date the file was retrieved. Not necessary if referencing a hash.",
+			"type": "date",
+			"suggested": true
+		},
+		"commit": {
 			"label": "Commit Hash",
 			"description": "The hash of the commit being referenced. Only required if the type is a commit.",
@@ Line 57: / Line 63: @@
 			"required": true
 		},
-		"commit": {
+		"date": {
-			"label": "File Commit",
+			"label": "Commit Date",
-			"description": "The commit hash of the file version being referenced. Only required if the specified type is a file.",
+			"description": "The day the commit was committed.",
-			"type": "string"
+			"type": "date"
-		},
-		"retrieved": {
-			"label": "Retrieved Date",
-			"description": "The date the file was retrieved. Not necessary if referencing a hash.",
-			"type": "date",
-			"suggested": true
 		}
 	},
@@ Line 76: / Line 76: @@
 		"repo",
 		"type",
-		"hash",
 		"commit",
-		"retrieved"
+		"retrieved",
+		"date"
 	],
 	"description": "Cites a GitHub commit or file."
 }
 </templatedata>