Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 1.45 KB

File metadata and controls

42 lines (30 loc) · 1.45 KB

Contributing to conformance-kit

The most useful thing you can send

An implementation that disagrees with ours about a refusal. Two implementations that have never met agreeing about what to reject is the only real evidence a specification says what it means. If yours rejects a document ours accepts, that is a finding and we want it — open an issue with the document and both verdicts.

Everything else is welcome too: bug reports, failing test cases, documentation that was wrong, and code.

Sign-off, not a licence assignment

We use the Developer Certificate of Origin. Sign your commits with git commit -s, which appends:

Signed-off-by: Your Name <you@example.com>

That is the whole bar. There is no CLA and you do not assign copyright to anybody. A contributor licence agreement is a negotiation, and asking for one is how a project with four contributors stays a project with four contributors.

Before you open a pull request

npm ci
npm test

A test that reads prose punishes an explanation, so assert on behaviour rather than on a file containing a string. And every walk carries a guard against resolving nothing: a traversal that finds no files reports a clean repository and reads exactly like one.

What gets a pull request rejected

Nothing, silently. If a change is not right for this repository you get a reason, and the reason is on the pull request where the next person can read it.