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

docs(QUICKSTART.md): created QUICKSTART.md #369

Merged
merged 6 commits into from
May 12, 2024

Conversation

vxdguy
Copy link
Contributor

@vxdguy vxdguy commented May 5, 2022

Created QUICKSTART.md -- a starting point for someone new to this extension.

@ryanluker ryanluker changed the title docs(QUICKSTART.md): crerated QUICKSTART.md docs(QUICKSTART.md): created QUICKSTART.md May 6, 2022
@ryanluker
Copy link
Owner

@vxdguy Excellent work and documentation on this!
I will link this to the ticket #333 , as it is related and gets us a good portion of the way to having some intro documentation.
I don't think we will close the above ticket yet as I still want to take a stab at the walkthroughs, but this can definitely go into release 2.10.0.


* *Coverage Gutters* supports LCOV, CLOVER, COBERTURA, and JACOCO coverage files

* Generation of the coverage file is language specific and is beyond the scope of this extension.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe mention after this that they could look at the examples for scenarios on how to generate the coverage files.
https://github.com/ryanluker/vscode-coverage-gutters/tree/master/example/ruby#ruby

QUICKSTART/QUICKSTART.md Outdated Show resolved Hide resolved
Copy link
Owner

@ryanluker ryanluker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some minor tweaks but looking really great so far!

@@ -0,0 +1,258 @@

# Quickstart for VSCODE-CODE-COVERAGE
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should link this document from the readme that is exposed on the vscode marketplace. (https://github.com/ryanluker/vscode-coverage-gutters/blob/master/README.md)

@EagleoutIce
Copy link
Contributor

Is something missing here? Or why was this not merged as far as I can see?

@ryanluker
Copy link
Owner

ryanluker commented May 12, 2024

Is something missing here? Or why was this not merged as far as I can see?

@EagleoutIce Hmm after checking nothing was springing to mind, so I will go ahead and merge this!
Thanks for the poke!

@ryanluker
Copy link
Owner

@vxdguy Thanks for the contribution!

@ryanluker ryanluker merged commit 027f520 into ryanluker:master May 12, 2024
3 of 4 checks passed
@ryanluker ryanluker added this to the 2.12.0 milestone May 12, 2024
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

Successfully merging this pull request may close these issues.

3 participants