diff options
Diffstat (limited to 'testing/web-platform/tests/annotation-protocol/CONTRIBUTING.md')
-rw-r--r-- | testing/web-platform/tests/annotation-protocol/CONTRIBUTING.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/testing/web-platform/tests/annotation-protocol/CONTRIBUTING.md b/testing/web-platform/tests/annotation-protocol/CONTRIBUTING.md new file mode 100644 index 000000000..cc585fd7d --- /dev/null +++ b/testing/web-platform/tests/annotation-protocol/CONTRIBUTING.md @@ -0,0 +1,38 @@ +Annotation-Protocol: Guidelines for Contributing Tests +====================================================== + +This document describes the method people should use for authoring tests and +integrating them into the repository. Anyone is welcome to submit new tests to +this collection. If you do, please create the tests following the guidelines +below. Then submit them as a pull request so they can be evaluated + +Structure +--------- + +Tests are organized by client or server, and then by major section of the Annotation +Protocol specification. The folders associated with these are: + +* client - tests a client needs to run +* server - tests to be run against a server + +Within these folders, special files ending with the suffix ".html" provide the source +for the test as a set javascript calls to perform the test. + +* scripts - JavaScript that are included by tests +* tools - supporting scripts and files + +Client Test Cases +----------------- + +@@@TODO@@@ describe the structure of client test cases. + +Server Test Cases +----------------- + +@@@TODO@@@ describe the structure of server test cases. + + +Command Line Tools +------------------ + +### Stand-alone Annotation Server ### |