Skip to content

Commit 027afc4

Browse files
committed
Add check for missing readme in platforms
1 parent b7b4633 commit 027afc4

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

check/checkconfigurations/checkconfigurations.go

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1226,6 +1226,21 @@ var configurations = []Type{
12261226
ErrorModes: []checkmode.Type{checkmode.Default},
12271227
CheckFunction: checkfunctions.BoardsTxtFormat,
12281228
},
1229+
{
1230+
ProjectType: projecttype.Platform,
1231+
Category: "structure",
1232+
Subcategory: "",
1233+
ID: "",
1234+
Brief: "no readme",
1235+
Description: "",
1236+
MessageTemplate: "No readme found. Please document your library. See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-readmes",
1237+
DisableModes: nil,
1238+
EnableModes: []checkmode.Type{checkmode.Default},
1239+
InfoModes: nil,
1240+
WarningModes: []checkmode.Type{checkmode.Default},
1241+
ErrorModes: []checkmode.Type{checkmode.Strict},
1242+
CheckFunction: checkfunctions.MissingReadme,
1243+
},
12291244
{
12301245
ProjectType: projecttype.Platform,
12311246
Category: "structure",

0 commit comments

Comments
 (0)