*: add CONTRIBUTING.MD #197
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
hasbro17
reviewed
Apr 26, 2018
| ## Getting started | ||
|
|
||
| - Fork the repository on GitHub | ||
| - See the [developer guide](./doc/dev/developer_guide.md) for build instructions |
There was a problem hiding this comment.
We don't have a separate developer guide yet. But we already have the build instructions on the README/user-guide. We'll have to make do with that until we write more developer docs.
So rephrase it to:
See the user-guide for build instructions.
There was a problem hiding this comment.
Sorry just saw the developer guide down below :)
hasbro17
reviewed
Apr 26, 2018
CONTRIBUTING.MD
Outdated
| @@ -0,0 +1,64 @@ | |||
| # How to contribute | |||
|
|
|||
| Operator SDK is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers, and other resources to help get contributions into vault-operator. | |||
There was a problem hiding this comment.
Replace vault-operator with operator-sdk here and in other places down below.
|
LGTM |
hasbro17
reviewed
Apr 26, 2018
doc/dev/developer_guide.md
Outdated
|
|
||
| ## Testing | ||
|
|
||
| Perform unit test: |
|
LGTM after nit |
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.
cc/ @hasbro17 @spahl @philips