caioluis / logto-rs Goto Github PK

Before releasing as production ready, I would like to go through it once more and check everything. I may need help, as I'm not fully aware of what could go wrong.

The code is completely undocumented, and this feels horrible

• Document every function so it can be easily understood when using the crate.
• It could also be nice to meta-document things, so I can share with the Discord community.
• Link the tests to the documentation, so that it doesn't become obsolete when the code changes.

I think I could benefit from having a better convention for the SDK. I felt I was inconsistent during the development.

• TBD: gather examples and paste them here.

Currently the error handling in the library is not consistent and could benefit from some improvements on how it handles them. The snippets where we can see me dribbling the compiler need to go away, for it to be ready for production.

Set up GitHub Actions for automated tests on pull requests and new version tagging.

• It could be nice to document the process so I can refer back to it and share with the junior SWE community.