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

[meta issue] code quality improvement plan #2

Open
5 tasks
ofey404 opened this issue Apr 29, 2023 · 1 comment
Open
5 tasks

[meta issue] code quality improvement plan #2

ofey404 opened this issue Apr 29, 2023 · 1 comment

Comments

@ofey404
Copy link
Collaborator

ofey404 commented Apr 29, 2023

This is a meta issue, tracking the progress of a multi-step change.

Purpose

We have something minimum working now, to verify the idea.

But without basic quality assurance, the codebase would decay, and developer productivity would drop to an unacceptable status. And refactor would be impossible.

So this issue proposes the integration of basic quality control methods into this repo.

Idea: incremental is the key

This must be an incremental process.

Incremental means:

The key to incremental‐ism is not just splitting up the work into a series of small steps but splitting up the work in such a way that every step brings its own value—even if the later steps never happen.

--"Terraform: Up & Running" by Yevgeniy Brikman

It's not about spending 7 days to refactor the whole codebase, pause the development of all new features, and pray for everything would work fine.

I'll do it bit by bit, every step is self-contained.

Roadmap

For those working parts, I should ensure they are still working after each step.

@ofey404
Copy link
Collaborator Author

ofey404 commented Apr 30, 2023

FastAPI file structure best practice

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

No branches or pull requests

1 participant