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

A future Zero TODO comment policy #244

Open
bouncepaw opened this issue Jul 12, 2024 · 1 comment
Open

A future Zero TODO comment policy #244

bouncepaw opened this issue Jul 12, 2024 · 1 comment

Comments

@bouncepaw
Copy link
Owner

I want to employ a new development technique in Mycorrhiza development. The rules are simple:

  1. On the master branch, in the code, there must be no comments starting with TODO: or similar markers.
  2. If there is a TODO:, and you need to get rid of it, there are two approaches:
    1. Actually do what is written. This is the time to do it!
    2. Make an issue about this possible improvement, linking the related code.

That's it.

Currently, there are almost 40 of these TODO:s. This is a mess!

I will slowly start doing it one day, hopefully. I state no ETA.

@bouncepaw
Copy link
Owner Author

The rationale is simple. I forget about these comments...

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