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

remove references to sunrisemovement issue tracker #9

Open
skyfaller opened this issue Mar 6, 2021 · 0 comments
Open

remove references to sunrisemovement issue tracker #9

skyfaller opened this issue Mar 6, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@skyfaller
Copy link
Contributor

We misguidedly wanted to create bi-directional links between GitHub issues and code comments: sunrisemovement/devops#2. This was a huge mistake, a maintenance nightmare and harmful to portability if you forked the repo or moved to a different code forge. This might be a different story if you were using something like git-bug and all of the issues lived in the repo itself.

At any rate, all of the TODO: comments featuring links to the old issue tracker should be updated/removed, and we should avoid linking to external issue trackers from code comments. Let's stick to one-way links, from the issue tracker to the code. TODO comments are searchable from the code e.g. when offline on the train, and are fine by themselves.

@skyfaller skyfaller added the documentation Improvements or additions to documentation label Mar 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant