Skip to content

Commit ee04ca0

Browse files
authored
Create CONTRIBUTING.md
Proposal for a process to contribute tests
1 parent 3e69597 commit ee04ca0

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing tests
2+
3+
The following is a proposal for a process by which tests can be contributed. The process will need testing and reviewing
4+
so is likely to change.
5+
6+
* Add an issue for new tests using the label “Proposed Test Case” - this should reference the specification requirement
7+
to be tested and outline how you expect to test that requirement.
8+
* When someone picks up an issue, add the label “In Progress”.
9+
* Any discussion on how to implement the test should be captured in the issue.
10+
* A new test will need the following:
11+
* An entry in the relevant manifest file (e.g. in protocol/ or web-access-control/). The initial status should be
12+
`td:reviewStatus td:unreviewed`.
13+
* If there are comments to make about the requirement, e.g. saying why a particular implementation doesn’t support it,
14+
these can be added to the matching requirement-comments.ttl with `rdfs:comment`.
15+
* Create the feature file - see notes in the [README](README.md) and refer to other tests as examples of common patterns.
16+
* Submit a PR and request a review from another contributor (e.g. @edwardsph)
17+
* The reviewer, at this stage, will focus on the test implementation more than how well it tests the requirement.
18+
* The test is then merged and will be used by various Solid server implementors. This will provide feedback that will be part
19+
of a subsequent review by specification editors. If the test is approved by the editors, the manifest status will change
20+
to `td:approved`. Note the process for review by editors is not yet defined.
21+
22+
For advice on writing tests, you are welcome to contact @edwardsph via https://gitter.im/solid/test-suite

0 commit comments

Comments
 (0)