No TODO comments, but Git Hub issues are fine

[philippecamacho]

Only CAPE repository.

Check the following directories

• [ ] contracts
  • [ ] #585
  • [ ] contracts/contracts/libaries/BN254.sol
  • [ ] contracts/contracts/verifier
  • [ ] contracts/rust/plonk_verifier/mod.rs
• [ ] eqs
• [ ] relayer
• [ ] wallet
• [ ] nix,bin, main directory

[alxiong]

Honestly, as I'm removing the TODO, I started to think this guideline is not the best idea.

Conventionally, people have keywords like TODO: | FIXME: | NOTE: | ... in code comment for different purposes. Inlined TODO and github issue should be complementary rather than exclusive since you can only link to a file at specific commit, and might get out of sync if the code gets modified or removed.

The best workflow IMHO is add temporary TODO: during development, and once in a while (before next release or end of a sprint or milestone) we turn them into issue & update the TODO to link to the github issue instead of directly removing the comment. Meanwhile, we should remove all FIXME: before each release of course.

☝️ benefit of this workflow is:

• when someone try to remove or edit the code, he/she will notice the TODO and the linked github issue in the comment, and therefore be careful or notify the issue subscriber
• there's no need for petty and overwhlemingly number of issue each tracking a single TODO, since we create them in batch and usually categorize them at the end of each sprint.

(cc @pictographer, @philippecamacho )

[philippecamacho]

Decision: only remove the obsolete TODOs cc @alxiong @sveitser