This repository has been archived by the owner on Sep 12, 2023. It is now read-only.
Add DEVELOPMENT.md doc #78
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
|
This change is |
DEVELOPMENT.md
Outdated
|
|
||
| git clone https://github.com/YOUR_USERNAME/common | ||
| cd common | ||
| git remote add upstream https://github.com/kubeflow/common |
There was a problem hiding this comment.
We can probably skip these steps in the doc and point to a GitHub tutorial for fork/pull request instead so this doc can focus on kubeflow/common.
There was a problem hiding this comment.
Good point. Point user to git flow official doc now.
DEVELOPMENT.md
Outdated
|
|
||
| ## For repository owners | ||
|
|
||
| Here's some guidelines for repository owners |
There was a problem hiding this comment.
Change to a complete sentence
DEVELOPMENT.md
Outdated
| Here's some guidelines for repository owners | ||
|
|
||
|
|
||
| ### commit style guide |
Signed-off-by: Jiaxin Shan <[email protected]>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: terrytangyuan The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Signed-off-by: Jiaxin Shan [email protected]
This doc gives a development guidance for other developer to easily onboard this.
It also address @gaocegege's feedback here.
#73 (comment)
Add a section to remind user don't edit codes from upstream.