From 8c16c1bbefcdc09349baecf8649f395f38aa6f6c Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Mon, 28 May 2012 01:57:12 +0200 Subject: [PATCH] Update schema and add docs for support --- doc/04-schema.md | 24 ++++++++++++++++++++++++ res/composer-schema.json | 9 ++++----- 2 files changed, 28 insertions(+), 5 deletions(-) diff --git a/doc/04-schema.md b/doc/04-schema.md index efbc28daf..0dfe86b90 100644 --- a/doc/04-schema.md +++ b/doc/04-schema.md @@ -200,6 +200,30 @@ An example: Optional, but highly recommended. +### support + +Various information to get support about the project. + +Support information includes the following: + +* **email:** Email address for support. +* **issues:** URL to the Issue Tracker. +* **forum:** URL to the Forum. +* **wiki:** URL to the Wiki. +* **irc:** IRC channel for support, as irc://server/channel. +* **source:** URL to browse or download the sources. + +An example: + + { + "support": { + "email": "support@example.org", + "irc": "irc://irc.freenode.org/composer" + } + } + +Optional. + ### Package links All of the following take an object which maps package names to diff --git a/res/composer-schema.json b/res/composer-schema.json index 70b386da3..8e54bd934 100644 --- a/res/composer-schema.json +++ b/res/composer-schema.json @@ -209,11 +209,10 @@ }, "support": { "type": "object", - "additionalProperties": true, "properties": { "email": { "type": "string", - "description": "Email address of the community.", + "description": "Email address for support.", "format": "email" }, "issues": { @@ -233,15 +232,15 @@ }, "irc": { "type": "string", - "description": "Irc support channel" + "description": "IRC channel for support, as irc://server/channel.", + "format": "uri" }, "source": { "type": "string", - "description": "URL to the sources", + "description": "URL to browse or download the sources.", "format": "uri" } } } - } }