Updating README #51
Merged
Updating README #51
Conversation
This file contains hidden or 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
emersodb
requested review from
fatemetkl,
jewelltaylor,
sanaAyrml and
yuchongzhang
jewelltaylor
reviewed
Sep 5, 2023
README.md
Outdated
|
|
||
| All tests for the library are housed in the tests folder. These are run using `pytest`, see [Running Tests](#running-tests) below. These tests are automatically run through GitHub integrations on PRs to the main branch of this repository. PRs that fail any of the tests will not be eligible to be merged until they are are fixed. | ||
|
|
||
| If you use VSCode for development, you can setup the tests with the testing integration so that you can run debugging and other IDK features. Setup will vary depending on your VSCode environment, but in your .vscode folder your `settings.json` might look something like |
jewelltaylor
reviewed
Sep 5, 2023
README.md
Outdated
| "." | ||
| ] | ||
| } | ||
| `````` |
Contributor
There was a problem hiding this comment.
Too many backticks? Or maybe this is some syntax I am unfamiliar with
Collaborator
Author
There was a problem hiding this comment.
Nope, just bad auto-complete from vscode 😂 good catch.
jewelltaylor
approved these changes
Sep 5, 2023
Contributor
jewelltaylor
left a comment
jewelltaylor
left a comment
There was a problem hiding this comment.
Awesome to have this updated README! Few very minor things but LGTM!
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.
Expanding the README.md and getting rid of the CONTRIBUTION.md as they were both very sparse.