aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Pooley (@zuedev) <zuedev@gmail.com>2026-02-05 15:38:03 +0000
committerAlex Pooley (@zuedev) <zuedev@gmail.com>2026-02-05 15:38:03 +0000
commit783c958aedfc2e538368e242b3f4c7b9dc2dbe54 (patch)
tree9ad3b27e59c95b8c74b25ffa5cee2aab7f7d0ec0
parentbabe61a4d581fad3acb4518cd70b4e9ee8b6c0c5 (diff)
downloadgitinfo-783c958aedfc2e538368e242b3f4c7b9dc2dbe54.tar
gitinfo-783c958aedfc2e538368e242b3f4c7b9dc2dbe54.tar.gz
gitinfo-783c958aedfc2e538368e242b3f4c7b9dc2dbe54.tar.bz2
gitinfo-783c958aedfc2e538368e242b3f4c7b9dc2dbe54.tar.xz
gitinfo-783c958aedfc2e538368e242b3f4c7b9dc2dbe54.zip
all keys should be optional
-rw-r--r--README.md4
-rw-r--r--gitinfo.schema.json1
2 files changed, 3 insertions, 2 deletions
diff --git a/README.md b/README.md
index 32461fd..fc4f8d1 100644
--- a/README.md
+++ b/README.md
@@ -44,7 +44,9 @@ You can reference the schema in your `.gitinfo` file using the `$schema` propert
### Supported Keys
-- `root`: The URL of the root repository. This key is mandatory and should point to the main hosting location of the repository that acts as the source of truth for the codebase.
+All keys are optional. Include only the fields relevant to your project.
+
+- `root`: The URL of the root repository, pointing to the main hosting location that acts as the source of truth for the codebase.
- `gitmail`: An email address associated with the repository for submitting git patches. See [git-send-email.io](https://git-send-email.io/) for details.
- `icon`: A public URL or data URI formatted image (PNG, SVG, etc.) representing an icon for the repository. If using a data URI, we recommend using base64 encoding for compatibility.
- `description`: A brief description of the repository's purpose or contents.
diff --git a/gitinfo.schema.json b/gitinfo.schema.json
index c382f3b..7aac4d5 100644
--- a/gitinfo.schema.json
+++ b/gitinfo.schema.json
@@ -4,7 +4,6 @@
"title": ".gitinfo",
"description": "Schema for the .gitinfo file specification",
"type": "object",
- "required": ["root"],
"properties": {
"root": {
"type": "string",