docs: Add development environment section to readme #822
Conversation
TerryHowe
requested review from
deitch,
jdolitsky,
sajayantony,
shizhMSFT and
SteveLasker
as code owners
There was a problem hiding this comment.
Second this! Thanks for the PR @TerryHowe. I've given some minor suggestions that would help fix some unwanted behavior.
Codecov Report
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more @@ Coverage Diff @@
## main #822 +/- ##
=======================================
Coverage 63.50% 63.50%
=======================================
Files 21 21
Lines 844 844
=======================================
Hits 536 536
Misses 265 265
Partials 43 43 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
There was a problem hiding this comment.
Being more explicit on the details helps folks get started.
Thanks for the addition, @TerryHowe
|
LGTM 🚀 |
There was a problem hiding this comment.
We should mention and probably merge this doc https://oras.land/cli/5_developer_guide/?
There was a problem hiding this comment.
Oh yes why don't we point to - https://oras.land/cli/5_developer_guide/
And add to that any improvements?
Would avoid things going stale and having to keep them consistent in 2 places.
There was a problem hiding this comment.
LGTM. BTW @TerryHowe, the merging rule now checks for unresolved discussion. If you want to merge this PR, you need to resolve all the comments.
|
Updated the docs here oras-project/oras-www#119 and just linked to them in this PR. This was part of the CNCF template work to have a development guide in the readme. |
There was a problem hiding this comment.
oras-project/oras-www#119 has been approved and merged. I think it's ready to accept this one.
Signed-off-by: Terry Howe <tlhowe@amazon.com>
Each ORAS sub-project should have a section in the README.md about setting up a development environment, since each sub-project is unique.