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

Easy way to save report in md format #36

Open
thamara opened this issue Nov 8, 2021 · 3 comments
Open

Easy way to save report in md format #36

thamara opened this issue Nov 8, 2021 · 3 comments
Assignees

Comments

@thamara
Copy link
Owner

thamara commented Nov 8, 2021

The MD report generated by the extension cannot be easily saved. We should make it possible, as well as have an option to define a default report location or something like this.

@tomotvos
Copy link

Absolutely on the default location. In fact, why not make it into the root of the project so that it can be checked in and shared with team members. While annotations may be private reminders, they can also serve as code review notes.

@thamara
Copy link
Owner Author

thamara commented Nov 24, 2021

@tomotvos That's one interesting idea, which I must say is the opposite of my use case hahaha. In my case, I don't want anything visible that could be easily committed by mistake.
But your case makes a lot of sense, and maybe my use case is the exception. But allowing it to be configurable, with a default value as the root can support both user cases :)

@thamara thamara self-assigned this Jan 8, 2022
@ThomasA
Copy link

ThomasA commented Mar 7, 2024

I have just discovered the Code Annotation extension and I am currently exploring it for planning refactoring of a project.
I am going through the code base and making notes on which parts I think should be moved to other locations etc. I find it too messy to litter my source files with comments and check those in. I like the idea much better of being able to keep my comments on this separate from the actual source code, yet clearly linked to specific places in the source code.
Your extension @thamara looks quite fit for this purpose. Like @tomotvos, I would also like to be able to share these notes with my colleagues, so I was looking to see if the extension stores the notes in a sidecar file somewhere in my repo that I could just commit and let colleagues use with the extension on their computers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants