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

Guidance around TODO / FIXME comments in code #22

Open
QuintinWillison opened this issue Feb 25, 2022 · 0 comments
Open

Guidance around TODO / FIXME comments in code #22

QuintinWillison opened this issue Feb 25, 2022 · 0 comments
Labels
SDK Relates to the Ably SDK Team and our ways of working in open source.

Comments

@QuintinWillison
Copy link
Contributor

QuintinWillison commented Feb 25, 2022

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.

@QuintinWillison QuintinWillison added the SDK Relates to the Ably SDK Team and our ways of working in open source. label Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
SDK Relates to the Ably SDK Team and our ways of working in open source.
Development

No branches or pull requests

1 participant