search

ably / engineering

Ably's new home for engineering guidance, including content previously served from Confluence at engineering.ably.com.
https://engineering.ably.com/
Apache License 2.0
2 stars 6 forks source link

Guidance around `TODO` / `FIXME` comments in code #22

Open QuintinWillison opened 2 years ago

QuintinWillison commented 2 years ago

We want to avoid parallel backlogs that are untracked because they only exist in the source code.

All code commentary that documents some more work that should be done must link out to a GitHub issue. And the GitHub issue must provide a link back to the comment - e.g. source code line perma-link.