Add info to the README.md and CONTRIBUTING.md files #4
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
…n and contributing files.
|
@jewelltaylor I've added some information about building and running what we have so far in the #3 PR. Let me know if there is more stuff you'd like to see there. |
jewelltaylor
reviewed
Feb 9, 2024
| ## Development dependencies | ||
|
|
||
| To install development dependencies, first you need to create a virtual environment. | ||
| The easiest way is by using the [virtualenv](https://pypi.org/project/virtualenv/) package: |
There was a problem hiding this comment.
Should we explicitly mention we expect python between 3.9 and 3.11? Or it is it enough to have it in the pyproject.toml
There was a problem hiding this comment.
I think having it in pyproject.toml is enough, we don't have a hard requirement on it ourselves. Besides, when we change it, it's gonna be one less thing for us to worry about.
jewelltaylor
approved these changes
Feb 15, 2024
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.
PR Type
Documentation
Short Description
Clickup Ticket(s): https://app.clickup.com/t/86877aha9
Adding information about building and running the project into readme and contributing files.
Tests Added
NA