Updated CONTRIBUTING and getting-started docs #4744
Merged
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
pb8o
reviewed
Aug 22, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4744 +/- ##
=======================================
Coverage 84.34% 84.34%
=======================================
Files 249 249
Lines 27461 27461
=======================================
Hits 23162 23162
Misses 4299 4299
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
pb8o
previously approved these changes
Aug 23, 2024
5 tasks
roypat
reviewed
Aug 27, 2024
seafoodfry
force-pushed
the
docs/getting-started
branch
3 times, most recently
from
0c29b2d to
0d6ca38
Compare
|
Forced push to rebase with the latest from upstream/main (and because I forgot to cleanup one of the github-style footnotes). |
pb8o
approved these changes
Aug 28, 2024
roypat
approved these changes
Aug 28, 2024
Since the `./tools/devctr` Python project is a poetry project, it made more sense to actually add instructions that encouraged the use of poetry as opposed to plain ol' python virtual environments. Also, since the poetry project is using an old version of python, `3.10.*`, we added a `.python-version` file so that people could use pyenv - which is the recommended tool to manage python versions by poetry, see https://python-poetry.org/docs/managing-environments/ Signed-off-by: seafoodfry <99568361+seafoodfry@users.noreply.github.com>
seafoodfry
force-pushed
the
docs/getting-started
branch
from
0d6ca38 to
3cd0d1b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Changes
./tools/devctrpoetry project for the pre-commit..python-versionfile to help the installation of the poetry project which supports python versions 3.10.*Reason
Had to figure out these details while getting started.
Figured I should try contributing this info back into the project.
License Acceptance
By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following Developer
Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.PR Checklist
PR.
CHANGELOG.md.TODOs link to an issue.contribution quality standards.
rust-vmm.