Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document against the Ruby or Go client #68

Open
pbrisbin opened this issue Jul 14, 2021 · 0 comments
Open

Document against the Ruby or Go client #68

pbrisbin opened this issue Jul 14, 2021 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@pbrisbin
Copy link
Member

As far as I can tell, Faktory considers either its Ruby or Go client as "specifications by implementation" for how a Faktory client ought to behave.

It would be nice to put a markdown document in this repository that shows code snippets for each part of the API in Ruby or Go and then the corresponding Haskell that our client supports for the same operation.

We can highlight any gaps or when our ergonomics differ, and seek to normalize to the specification over time whenever it makes sense (or explain when it doesn't).

@pbrisbin pbrisbin added help wanted Extra attention is needed good first issue Good for newcomers labels Jul 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: 👜 To do
Development

No branches or pull requests

1 participant