search

acdh-oeaw / template-app-nuxt

Template repository for Nuxt 3 apps
https://template-app-nuxt.acdh-ch-dev.oeaw.ac.at
MIT License
3 stars 1 forks source link

Open issues in code lack markers #12

Open koeaw opened 1 year ago

koeaw commented 1 year ago

I'd ask for open issues pointed out in the code to be marked with one of the standard tags used/recognised by major IDEs to make it easier to find them, like TODO or FIXME.

I reference this repo regularly to try to figure out problems I'm running into with Frischmuth, and while code comments + links to open GitHub issues elsewhere are appreciated, it'd be a time-saver to be able to filter for those. Additionally, it'd help with keeping them updated/for later code cleanup.

Example: https://github.com/acdh-oeaw/template-app-nuxt/blob/f8a8b607d4680b6a05faeaa7f4d6f94e69e716f6/error.vue#L5 Not sure if @see is meant to serve as TODO marker here, but I've never heard of it used that way and my IDE interprets it to mean something different (as does GitHub, evidently).

stefanprobst commented 1 year ago

this is jsdoc - see https://jsdoc.app/tags-see.html

koeaw commented 1 year ago

this is jsdoc - see https://jsdoc.app/tags-see.html

I see, thanks.

Usage of the tag seems to be independent of the original issue, though, i.e. being (un)able to quickly reference or filter by open/unresolved/WIP tasks or issues. (Not every TODO necessitates a reference to an outside resource; not every pointer to an outside resource is necessarily related to a TODO.)

I came across one FIXME for a TODO in the copy of the repo I was provided with, which is how I noticed this discrepancy in the first place.

As said, consistent labelling would help save time. I could tag existing TODOs I'm aware of myself, but a) since my first PR has been sitting around untouched for 3 months, it's unclear to me if this repo even accepts contributions and b) for this to make a difference longer term, it would have to be turned into a convention/guideline.