pactflow / pactflow/pactflow-jsonschema-example
Clarify "downloaded schema", "golden schema" & "provider generated schema"
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 7
- Forks
- 0
- Avg merge
- 10h 38m
- Merged PRs (30d)
- 2
Description
The usage of the terms "downloaded schema", "golden schema" & "provider generated schema" in README.md are a bit ambiguous, it would be great to clarify them.
Also, to understand how the "golden schema" comes to be, when it's updated etc.
From reading the code, it looks like the provider-generated schema is expected to be identical (whitespace notwithstanding) to the golden schema.
And the golden schema (which is identical to the provider-generated schema) should be compatible with the downloaded pact (according to json-schema-diff).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with README.md and the existing descriptions of the downloaded, golden, and provider-generated schemas. Trace how the golden schema is created and updated, then document the relationship between the provider-generated schema, golden schema, downloaded pact, and json-schema-diff so the terminology and expected compatibility are explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100