docs: add clarification about goals of this project #33
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JaKXz
previously requested changes
Sep 21, 2018
README.md
Outdated
| ## Goals of Project | ||
|
|
||
| A fully functional code coverage solution using only V8's native coverage | ||
| features and minimal user-land modules: |
There was a problem hiding this comment.
Being strict here, this sentence does not really tell me what the following list is for. I would add:
...modules, so that we fit these constraints: or something to that effect.
There was a problem hiding this comment.
Glad to make this change 👍
README.md
Outdated
|
|
||
| c8 uses | ||
| [bleeding edge Node.js features](https://github.com/nodejs/node/pull/22527), | ||
| make sure you're running Node.js `>= 10.10.0`. | ||
|
|
||
| ## Goals of Project |
There was a problem hiding this comment.
nit: Goals of this Project or Goals of the Project.
|
@profnandaa I'll let you make these couple patches since you've put your hand up; have a couple other tasks on my plate today, but we can land as soon as we've satisfied @JaKXz. |
|
Looks good to me, thanks for adding this! |
mcknasty
pushed a commit
to mcknasty/c8
that referenced
this pull request
Feb 2, 2024
Clarify project goals: I'd like this project to demonstrate a powerful code coverage solution relying primarily on native V8 functionality, and minimal user-land modules -- @bcoe
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@demurgos and I have been having long conversations about implementation details surrounding c8, and I think part of the problem was that I've done a poor job of describing the goals I have in mind (they lived only in my head, which isn't useful).
tldr; I'd like this project to demonstrate a powerful code coverage solution relying primarily on native V8 functionality, and minimal user-land modules.
data-transformations are okay, but I don't want to parse JavaScript with Babel, muck with Node's runtime, etc.