Skip to content

Commit 3ad7fb4

Browse files
committed
validators: Report repos with missing descriptions
These descriptions improve social shares, and possibly search results.
1 parent a8f505f commit 3ad7fb4

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

adabot/lib/circuitpython_library_validators.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
" without reference to import errno. See issue " \
5757
"https://github.com/adafruit/circuitpython/issues/1582"
5858
ERROR_MISMATCHED_READTHEDOCS = "Mismatched readthedocs.yml"
59+
ERROR_MISSING_DESCRIPTION = "Missing repository description"
5960
ERROR_MISSING_EXAMPLE_FILES = "Missing .py files in examples folder"
6061
ERROR_MISSING_EXAMPLE_FOLDER = "Missing examples folder"
6162
ERROR_EXAMPLE_MISSING_SENSORNAME = "Example file(s) missing sensor/library name"
@@ -209,6 +210,9 @@ def validate_repo_state(self, repo):
209210

210211
errors = []
211212

213+
if not repo_fields.get("description"):
214+
errors.append(ERROR_MISSING_DESCRIPTION)
215+
212216
if repo_fields.get("has_wiki"):
213217
errors.append(ERROR_WIKI_DISABLED)
214218

0 commit comments

Comments
 (0)