From 3f45c44242487a203833745ffd78963f9fabf303 Mon Sep 17 00:00:00 2001 From: Christian Hammond Date: Mon, 18 Nov 2013 17:06:41 -0800 Subject: [PATCH] Add documentation for the rb-extension-pack repository. People were a bit confused about the purpose of rb-extension-pack and it was unclear which extensions were usable and which weren't. To fix this, I'm adding a series of READMEs, plus a CONTRIBUTING file for GitHub, to make it clear what the status and requirements are for each extension. Going forward, every extension should provide a README in the same format. --- CONTRIBUTING | 11 +++++++++++ README.md | 9 +++++++++ rbseverity/README.md | 27 +++++++++++++++++++++++++++ rbwebhooks/README.md | 22 ++++++++++++++++++++++ rbxmlreview/README.md | 23 +++++++++++++++++++++++ 5 files changed, 92 insertions(+) create mode 100644 CONTRIBUTING create mode 100644 README.md create mode 100644 rbseverity/README.md create mode 100644 rbwebhooks/README.md create mode 100644 rbxmlreview/README.md diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..024fa20 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,11 @@ +If you're looking to contribute to an extension, we've written up a handy +little guide that will be useful to you: + +http://www.reviewboard.org/docs/codebase/dev/contributing-patches/ + +You do not need to clone this repository to produce new extensions. We just use +it as a placeholder for any production or sample extensions we create. + +Please note that we do *not* accept pull requests! Instead, every patch must +go through a code review process on our own Review Board server at +http://reviews.reviewboard.org/. diff --git a/README.md b/README.md new file mode 100644 index 0000000..de1d657 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +Review Board Extension Pack +=========================== + +This repository contains a variety of extensions for Review Board. Some of +these are experimental and not complete, while others can be used on a +production server. + +See the READMEs in each directory for an explanation of the extension, the +versions of Review Board its compatible with, and the status of the extension. diff --git a/rbseverity/README.md b/rbseverity/README.md new file mode 100644 index 0000000..ccd6301 --- /dev/null +++ b/rbseverity/README.md @@ -0,0 +1,27 @@ +Comment Severity Extension +========================== + +Overview +-------- + +This extension provides support for setting the severity level of a comment +when commenting on a diff or a file attachment. + +The comment dialog is extended to replace the `Save` button with a series +of severity buttons. Clicking one of these buttons will save the comment at +that severity level. + +Severities are shown alongside the comments in reviews and in e-mails, and +can be altered in the review dialog. + + +Requirements +------------ + +This extension requires Review Board 2.0 beta 1 or higher. + + +Status +------ + +This extension is production-ready. diff --git a/rbwebhooks/README.md b/rbwebhooks/README.md new file mode 100644 index 0000000..cecfcd8 --- /dev/null +++ b/rbwebhooks/README.md @@ -0,0 +1,22 @@ +Webhooks Extension +================== + +Overview +-------- + +This extension adds support for webhooks. These can be used to notify a +service when a review request is published by way of an HTTP request +with a JSON payload containing information on the review request. + + +Requirements +------------ + +This extension requires Review Board 1.7.x or higher. + + +Status +------ + +This extension is currently unmaintained and is missing several features. +Contributions are welcome. diff --git a/rbxmlreview/README.md b/rbxmlreview/README.md new file mode 100644 index 0000000..2c33363 --- /dev/null +++ b/rbxmlreview/README.md @@ -0,0 +1,23 @@ +XML Review Extension +==================== + +Overview +-------- + +This is a sample extension for providing a simple review UI for XML files. +It was a student project as part of [UCOSP](http://ucosp.ca/). + +The extension is a work-in-progress and is not meant for use. + + +Requirements +------------ + +This extension requires Review Board 1.7.x or higher. + + +Status +------ + +This extension is currently unmaintained and not yet functional. Contributions +are welcome.