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

Move useless comments from source to Issues #66

Closed
bkcsoft opened this issue Nov 4, 2016 · 2 comments
Closed

Move useless comments from source to Issues #66

bkcsoft opened this issue Nov 4, 2016 · 2 comments
Labels
type/proposal The new feature has not been accepted yet but needs to be discussed first.

Comments

@bkcsoft
Copy link
Member

bkcsoft commented Nov 4, 2016

Running make fixme todo will print a nice list of TODO/FIXME-comments from source files. These should be moved to proper issues so that they can be 1) tracked and 2) people actually know about them 😆

There are more instances of these comments throughout the code, and those should be moved as well.

Thoughts?

--- Want to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/38952940-move-useless-comments-from-source-to-issues?utm_campaign=plugin&utm_content=tracker%2F47456670&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F47456670&utm_medium=issues&utm_source=github).
@strk
Copy link
Member

strk commented Nov 4, 2016

The existence of fixme and todo rules clearly makes those code comments NOT useless :)
If the issues creation/deletion can be automated then go for it, otherwise there's a risk of code and issues going out of sync.

I'd love for issues to be closer to code ..

@xinity xinity added the type/proposal The new feature has not been accepted yet but needs to be discussed first. label Nov 4, 2016
@xinity xinity added this to the 1.x.x milestone Nov 4, 2016
lunny pushed a commit to lunny/gitea that referenced this issue Feb 7, 2019
@mrsdizzie
Copy link
Member

Closing since we aren't going to remove these code comments

As an alternative to creating issues for each one there is this service which lists all TODO/fixme type comments for reference:

https://www.tickgit.com/browse?repo=github.com/go-gitea/gitea

And also provides a link to open an issue from any particular comment

@lunny lunny removed this from the 1.x.x milestone Sep 8, 2020
@go-gitea go-gitea locked and limited conversation to collaborators Nov 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type/proposal The new feature has not been accepted yet but needs to be discussed first.
Projects
None yet
Development

No branches or pull requests

5 participants