Update Document: contributor guide and Code of Conduct #169
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
|
update the contributor guide |
qmhu
reviewed
Mar 2, 2022
CONTRIBUTING.md
Outdated
| You can contribute to Crane in several ways. Here are some examples: | ||
|
|
||
| * Contribute to the Crane codebase. | ||
| * Contribute to the [Crane docs](https://github.com/gocrane/crane). |
There was a problem hiding this comment.
Since crane don't have document/web repo now ,we don't mention it.
CONTRIBUTING.md
Outdated
|
|
||
| ### Contribute to the Crane codebase | ||
|
|
||
| We encourage new comers actively join in Crane projects. The following paragraph introduce how to contribute in Crane way. |
There was a problem hiding this comment.
We need a Develop Guide here to help contributor know how to setup local env, prepare golang, docker and so on.
You can introduce some like this in this section.
CONTRIBUTING.md
Outdated
|
|
||
| ### Contribute to the Crane codebase | ||
|
|
||
| We encourage new comers actively join in Crane projects. The following paragraph introduce how to contribute in Crane way. |
CONTRIBUTING.md
Outdated
|
|
||
| #### Begin your contribute | ||
|
|
||
| If you find a typo in document, find a bug in code, or want new features, or want to give suggestions, you can [open an issue on GitHub](https://github.com/gocrane/crane/issues/new) to report it. |
There was a problem hiding this comment.
how about change Contribute to the Crane codebase to Develop Guide.
You can rename workflow.MD for detail
| @@ -393,3 +393,9 @@ Something you should know about HPA recommendation: | |||
| ## RoadMap | |||
| Please see [this document](./docs/roadmaps/roadmap-1h-2022.md) to learn more. | |||
|
|
|||
| ## Contributing | |||
There was a problem hiding this comment.
Please also add Contributing and Code of Conduct in navigation.
|
done |
chenhong231
force-pushed
the
develop-issue#162
branch
from
b165f4b
to
70742fe
Compare
|
update document and squash commit. |
chenhong231
force-pushed
the
develop-issue#162
branch
from
70742fe
to
57b69e3
Compare
|
/LGTM |
mfanjie
reviewed
Mar 2, 2022
| @@ -25,6 +25,8 @@ Crane (FinOps Crane) is a cloud native open source project which manages cloud r | |||
| - [Analytics and Recommend Pod Resources](#analytics-and-recommend-pod-resources) | |||
| - [Analytics and Recommend HPA](#analytics-and-recommend-hpa) | |||
| - [RoadMap](#roadmap) | |||
| - [Contributing](#Contributing) | |||
There was a problem hiding this comment.
use contributing instead of Contributing to keep same style with other items?
qmhu
changed the title
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.
What is the purpose of the change
add contributor guide document
Brief changelog
new file: .github/PULL_REQUEST_TEMPLATE.md
new file: CODE_OF_CONDUCT.md
new file: CONTRIBUTING.md
modified: README.md
new file: WORKFLOW.md
Verifying this change
NONE
there are 2 things need to confirm:
PULL_REQUEST_TEMPLATE.md--------TODO: need to discuss the following step for crane project: basic checks pass,unit-test,integration-test
CONTRIBUTING.md -------------- TODO: need to discuss the committer nomination process.