wip: example ToC for maintainer guide #270
Conversation
mefellows
force-pushed
the
docs/maintainer-guide
branch
from
90edf26 to
d6b2a01
Compare
| - Maintainer meetings (how to stay in touch. Slack, Zoom monthly etc.) | ||
| - Roadmap (Where to find it, how to contribute to it, RFC process) | ||
| - Criteria for an implementation to be accepted into pact-foundation | ||
| - License should be MIT |
There was a problem hiding this comment.
yeah we have a handful of Apache 2.0 repos.
I noted about 9 don't have licenses, which probably should so will flag them for review.
|
|
||
| ## Quality | ||
|
|
||
| * [ ] TCK completed and published |
There was a problem hiding this comment.
Just a thought for checklist, from previous threads
sustainable CI, or repo pre-reqs, good practises.
in addition, docs, ie
- contributing guide
- developer guide
- readme
etc
There was a problem hiding this comment.
Yep, nice ideas. I just popped a few off the top of my head, but I think it will likely be getting down what we have initially with some "TODOs" that we can populate over time as needed.
|
Looks good for a starter for 10, from a dry paper review, will see if I can flesh out some bits this week as I write up some of the work done to do date on the pact-python work for loading the FFI, and performing the verification via the CLI or using the FFI directly in the language DSL. It's highlighting some gaps in my knowledge and where they may be discrepancies between ruby and rust, but even more so potentially discrepancies between client languages. Which is fine to highlight, and it means we can reason about, resolve and unify. Thanks for kicking this off |
|
After a discussion with @uglyog and @YOU54F one consideration to improve the DSL document, is to generate diagrams from code, such as the TS interface in Pact JS. The TS interface in JS uses a type-state pattern and shows how to construct an interface that is both user friendly and compatible with the FFI. Converting from TS to other languages (in an idiomatic way) would still require some human involvement, but it should be aided by the types. These projects look promising to attempt it:
tplant example: VSCode TS UML examples: |
An initial proposal outline for a maintainer guide.