search

bouncepaw / mycorrhiza

🍄📑 Filesystem and git-based wiki engine for the independent web written in Go and using Mycomarkup as its primary markup language.
https://mycorrhiza.wiki
GNU Affero General Public License v3.0
300 stars 26 forks source link

A future Zero TODO comment policy #244

Open bouncepaw opened 1 month ago

bouncepaw commented 1 month ago

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 commented 1 month ago

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