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
More examples with more detailed comment will help! #145
Comments
Hi @duckfly-tw Thanks for your kind words. I will forward them to @livio-a 😉 During the Christmas season, we take a little longer because many people are on well-deserved vacation. We do our best to complete the examples. Cheers |
This is a great project and you guys are awesome to open source it. More examples and documentation will definitely help! Best, |
Hi @raydeng83 thank you very much. @livio-a is doing a great job. Feedback like yours is why we are doing it. It makes working a pleasure 😊 |
Hi, are you open for pull request? I've just started working with your project and I find that the Godoc can be improved in some points. I find myself flipping through go doc, examples and source to find out how to implement the For example, Lines 11 to 13 in 94871af
When digging deeper into the example code, those questions are answered: 1: oidc/example/server/internal/storage.go Lines 159 to 163 in 94871af
2: oidc/example/server/internal/storage.go Lines 113 to 115 in 94871af
Therefore I would like to propose:
For example, I would do something like:
Let me know if you're open for PRs and I'll get started ;). |
Hi there, I am in the same situation as muhlemmer. I am trying to implement an OP for development and testing purpose, but even though there is an example, the interfaces to implement lack some documentations and comments. Moreover, I have the feeling they are a bit bloated, e.g. there are too many methods in each Storage and some interfaces seem to have several responsibilities. This makes the implementation quite difficult. |
Hey @muhlemmer and @Adirelle We're certainly open for PRs 😃 and would appreciate any help. And there's certainly lots of improvement possible on documentation. 😉 We started this project as we needed an OP for out own product (https://github.com/zitadel/zitadel) and wanted to separate the functionality into a package. We tried to abstract it as good as possible, but I'm sure there's room for improvement, too. If there are any suggestions on this, we can of course discuss this as well. |
I think that what @muhlemmer proposes would be a good start to improve the documentation. As for the interfaces, I think what is missing is some documentation about the entity-relation model used by the OP, and how entities are used. This could allow to write services and repository interfaces, which are easier to reason about and to implement. They could come as a separate package, with adapters to keep the compatibility with existing interfaces. |
Will close this issue for now, if we see new stuff popping up we will create dedicated issues for it. |
Is your feature request related to a problem? Please describe.
Big thank for your efforts on this great project!
I want to build an OP based on this project, but the OP example is too fuzzy for me to make the features I want.
Describe the solution you'd like
Add or modify OP examples:
Appreciate your help!
The text was updated successfully, but these errors were encountered: