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

Code improvements (tooling, async...) #31

Open
2 of 6 tasks
Tracked by #39
raphodn opened this issue Nov 16, 2023 · 2 comments · Fixed by #201
Open
2 of 6 tasks
Tracked by #39

Code improvements (tooling, async...) #31

raphodn opened this issue Nov 16, 2023 · 2 comments · Fixed by #201
Labels

Comments

@raphodn
Copy link
Member

raphodn commented Nov 16, 2023

Story

For the v1 we went a bit fast, here is a list of known improvements :

  • schema: add field descriptions (pydantic) & examples
  • background tasks: avoid passing db (see this discussion)
  • tests: teardown data between each test, add more tests
  • tests: use PostgreSQL instead of SQLite
  • documentation: improve it (ex: docker), add docstring
  • ci: upgrade release-please to v4
@teolemon
Copy link
Member

We could add automatic client library generation: https://github.com/marketplace/actions/generate-client-library-w-the-openapitools-generator

@kundan-bhardwaj
Copy link

@raphodn I am a newbie in opensource and want to fix this issue can you please elaborate this in detail.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Backlog
Development

Successfully merging a pull request may close this issue.

3 participants