Contribution guide updates for Quickstart authors #977
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
…ics. Signed-off-by: Paul Yuknewicz <[email protected]>
|
Started reviewing this... |
msfussell
reviewed
Jul 22, 2024
|
|
||
| ### Cutting a release of quickstarts | ||
| 1. Change to the release branch created above. | ||
| 2. Make sure the matching runtime and CLI versions are set to match intent in `global.env` file |
There was a problem hiding this comment.
can you point to where this file is.
| TODO | ||
|
|
||
| ### Authoring tests for new Quickstarts | ||
| TODO |
There was a problem hiding this comment.
When this is a community call recording can add a link here
| 2. Make sure the matching runtime and CLI versions are set to match intent in `global.env` file | ||
| 3. Create a new [Tag](https://github.com/dapr/quickstarts/tags) from this release branch in the form of v.M.mm-rcN, e.g. `v1.13-rc1`. | ||
| 4. After the final RC is promoted to a full release, create a new Tag dropping the RC, e.g. `v1.13.0`. | ||
| 5. Create a new [Release]() in the form of `v1.13` and reference the tag from last step. Note the releases have convention of no dot releases (e.g. v1.13.0) unless patched (e.g. v1.13.1). Include highlights and changelist in the release notes, and double check that contributors get credit. |
There was a problem hiding this comment.
- Brackets are empty for Release
- What are you saying here "Note the releases have convention of no dot releases (e.g. v1.13.0) unless patched (e.g. v1.13.1)" - do not understand the "no dot releases" reference here
There was a problem hiding this comment.
I will clarify that sentence. good catch.
| 1. Commit your changes and open a PR to the Dapr Quickstarts repository. | ||
| 1. Wait for the CI process to finish and make sure all checks are green. | ||
| 1. A maintainer of the project will be assigned, and you can expect a review within a few days. | ||
| 1. Make sure the checks/test actions pass with your changes. See [Test authoring] for information around how this works and how to troubleshoot. |
There was a problem hiding this comment.
See [Test authoring] - Needs a URL reference
Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Paul Yuknewicz <[email protected]>
Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Paul Yuknewicz <[email protected]>
Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Paul Yuknewicz <[email protected]>
Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Paul Yuknewicz <[email protected]>
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.
Description
Expand the CONTRIBUTING guide with:
Issue reference
We strive to have all PRs being opened based on an issue, where the problem or feature have been discussed prior to implementation.
Please reference the issue this PR will close: #967
Checklist
Please make sure you've completed the relevant tasks for this PR, out of the following list: