Built in the open.

complydoc is MIT licensed and made by the people below. Every pull request is read, and a first one is welcome.

How we work together.

We appreciate every pull request, from a one-line fix to a new loader. What we are building is a community of engineers who know complydoc deeply, and are at ease putting it into their own document pipelines.

  • Comment on an issue to be assigned before you start, so no two people do the same work.
  • Keep a pull request to one issue, with a test that fails without the change.
  • Open it into development. Every one is read and answered.
  • Everyone whose work ships is thanked by name in the release notes.

Setup, layout and conventions: CONTRIBUTING.md

A good place to start.

Issues labelled for a first contribution
Issues marked as a good place to start. Most of them add an identifier complydoc should recognise.

Not all of it is code.

Teach it a new identifier
A national ID, a tax number, a health number: each is a pattern and a validator, and the good first issues are mostly these.
Show us a document it reads wrong
A loader that drops a table, a page it calls clean that is not. A sample, or a description of one, is enough to start.
Make the docs clearer
Every guide runs its own examples in the tests, so a fix to a guide is checked like a fix to the code.
Work on complydoc4j
complydoc for Java writes the same report, and is checked against this package on every change.