Skip to content

Commit

Permalink
Merge pull request KhronosGroup#124 from greggman/readme-etc
Browse files Browse the repository at this point in the history
add some guidelines adding tests
  • Loading branch information
greggman committed Dec 28, 2012
2 parents 1c0cc4d + 0e5a374 commit ceb1719
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Expand Up @@ -4,6 +4,9 @@ This is the offical home of the Khronos
WebGL repository for the WebGL specifications
and the WebGL conformance test suite.

Before adding a new test or editing an existing test
<a href="sdk/test/test-guidelines.md"> please read these guidelines</a>.

You can find live versions of the specifications at
http://www.khronos.org/webgl/

Expand Down
3 changes: 3 additions & 0 deletions sdk/tests/README.md
@@ -1,6 +1,9 @@
Welcome to the WebGL Conformance Test Suite
===========================================

Note: Before adding a new test or editing an existing test
<a href="test-guidelines.md"> please read these guidelines</a>.

This is the initial release of the WebGL conformance test suite.

NOTE TO USERS: Unless you are a WebGL implementor, there is no need to submit
Expand Down
53 changes: 53 additions & 0 deletions sdk/tests/test-guidelines.md
@@ -0,0 +1,53 @@
Contributing WebGL conformance tests Guidelines
===============================================

Thank you for contibuting to the WebGL conformance tests.
Please try to follow these guidelines when submitting a test.

* All changes and/or new tests should go in the sdk/tests/conformance folder

The tests under conformance-suites are snapshots and are only to be updated by
the WebGL Working Group when "official" snapshots are taken.

* Please use the Khronos Group License (MIT)

These lines appears at the top of every html and js file under sdk/tests/conformance

<!--
/*
** Copyright (c) 2012 The Khronos Group Inc.
**
** Permission is hereby granted, free of charge, to any person obtaining a
** copy of this software and/or associated documentation files (the
** "Materials"), to deal in the Materials without restriction, including
** without limitation the rights to use, copy, modify, merge, publish,
** distribute, sublicense, and/or sell copies of the Materials, and to
** permit persons to whom the Materials are furnished to do so, subject to
** the following conditions:
**
** The above copyright notice and this permission notice shall be included
** in all copies or substantial portions of the Materials.
**
** THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
** CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
** MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
*/
-->

* Please use code similar to the code in existing tests

Ideally, copy an existing test and modify it for your new test. Try not to duplicate
code that already exists where approriate.

* If adding a new test edit the approriate 00_test_list.txt file

Each folder has a 00_test_list.txt file that lists the test in that folder.
Each new test should be prefixed with the option "--min-version <version>" where
version is 1 more than the newest official verison. At the time of this writing
all new tests should be prefixed with "--min-version 1.0.2"


0 comments on commit ceb1719

Please sign in to comment.