docs: Updates docs for CII. See #2641 #2643
Merged
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
alexec
commented
Apr 8, 2020
| @@ -0,0 +1,85 @@ | |||
| # How to setup your dev environment | |||
There was a problem hiding this comment.
this is lift-and-shift of CONTRUBITING.md
alexec
commented
Apr 8, 2020
| @@ -1,85 +1,24 @@ | |||
| # How to setup your dev environment | |||
There was a problem hiding this comment.
this is a completely new file
|
This is to tidy up the docs to help meet more of CNCF CII requirements. See #2614 |
simster7
reviewed
Apr 8, 2020
Co-Authored-By: Simon Behar <simbeh7@gmail.com>
This was
linked to
issues
Apr 8, 2020
alexec
changed the title
alexec
commented
Apr 9, 2020
| * [ ] I've signed the CLA and required builds are green. | ||
| * [ ] I've signed the CLA. | ||
| * [ ] I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged. | ||
| * [ ] My builds are green. Try syncing with master if they are not. |
There was a problem hiding this comment.
Provide a nudge on what to do if the build fails.
alexec
commented
Apr 9, 2020
| * [ ] Optional. I've added My organization is added to the USERS.md. | ||
| * [ ] I've signed the CLA and required builds are green. | ||
| * [ ] I've signed the CLA. | ||
| * [ ] I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged. |
edlee2121
approved these changes
Apr 10, 2020
| # How to setup your dev environment | ||
| ## Pre-requisites: | ||
|
|
||
| * Dep. `brew install dep` |
There was a problem hiding this comment.
On a different note, should we provide a dev container images that folks can use if they want so they don't have to install all these tools?
There was a problem hiding this comment.
someday, but not today
|
Kudos, SonarCloud Quality Gate passed!
|
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.
Checklist:
"fix(controller): Updates such and such. Fixes #1234".