Add clarification about project status #75
Conversation
| As there are various stable projects depending on the ORAS Go library, the | ||
| [`v1`](https://github.com/oras-project/oras-go/tree/v1) branch | ||
| is maintained for API stability, dependency updates, and security patches. | ||
| All `v1.*` releases are based upon this branch. |
There was a problem hiding this comment.
can we clarify which branch is “this”
There was a problem hiding this comment.
I believe this is clear from the previous sentence.
There was a problem hiding this comment.
To be clear, I meant since this is markdown the newline isn't registered, the last sentence appears in the same paragraph as the previous sentence where the v1 branch name and link was noted.
README.md
Outdated
| primary staging ground for the | ||
| [ORAS Artifacts Specification](https://github.com/oras-project/artifacts-spec), | ||
| changes are expected to occur regularly to meet new requirements. | ||
| This will likely introduce backward-incompatible changes, resulting in |
There was a problem hiding this comment.
maybe make this sound a little less scary by adding may, and will follow semver semantics with a 2.* release for consumers to opt in?
There was a problem hiding this comment.
Good idea @SteveLasker, I added a code suggestion for this below 😄 How does that sound?
|
looks great, with just a few nit changes. |
There was a problem hiding this comment.
@jdolitsky making one suggestion to note the project follows semver… it may be redundant once we add this to the community repo, but this one line I think would be worth it.
|
@scottrigby - your changes lgtm. Will wait for further review to commit them in |
Signed-off-by: Josh Dolitsky <josh@dolit.ski>
Co-authored-by: Scott Rigby <scott@r6by.com> Signed-off-by: Josh Dolitsky <josh@dolit.ski>
Co-authored-by: Scott Rigby <scott@r6by.com> Signed-off-by: Josh Dolitsky <josh@dolit.ski>
jdolitsky
force-pushed
the
branch-descriptions
branch
from
f26736b
to
c58f0c6
Compare
There was a problem hiding this comment.
lgtm!
@SteveLasker I think your concerns are addressed.
Everyone: this fits with the agreement from yesterday's meeting (see notes). Yay 🎉
|
LGTM |
No description provided.