Skip to content

Commit 937509a

Browse files
straight-shootaysbaddaden
authored andcommitted
Add SPEC for repository, homepage, documentation properties (#265)
1 parent 143f2e4 commit 937509a

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

SPEC.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,25 @@ work with the project (e.g., an automated documentation generator).
124124
crystal: 0.19.2
125125
```
126126

127+
### repository
128+
129+
The URL of the shard's canonical repository (String, recommended).
130+
131+
The URL should be compatible with typical VCS tools without modifications.
132+
`http`/`https` is preferred over VCS schemes like `git`.
133+
It is recommended that this URL is publicly available.
134+
135+
Copies of a shard (such as mirrors, development forks etc.) should point to the same
136+
canonical repository address, even if hosted at different locations.
137+
138+
### homepage
139+
140+
The URL of the shard's homepage (String).
141+
142+
### documentation
143+
144+
The URL to a website providing the shard's documentation for online browsing (String).
145+
127146
### dependencies
128147

129148
A list of required dependencies (Hash).

0 commit comments

Comments
 (0)