add contributing guidelines #632
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
Signed-off-by: cwen0 <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #632 +/- ##
==========================================
- Coverage 55.78% 55.57% -0.22%
==========================================
Files 68 68
Lines 4383 4398 +15
==========================================
- Hits 2445 2444 -1
- Misses 1768 1783 +15
- Partials 170 171 +1
Continue to review full report at Codecov.
|
dcalvin
reviewed
Jun 16, 2020
CONTRIBUTING.md
Outdated
| @@ -0,0 +1,175 @@ | |||
| # Contributing to Chaos Mesh | |||
|
|
|||
| Thanks for your help improving the project! | |||
There was a problem hiding this comment.
Suggested change
| Thanks for your help improving the project! | |
| Thanks for your help in improving the project! This document provides a step-by-step guide for general contributions to Chaos Mesh. If you want to develop a specific chaos type, you may also find [Development Guide](https://chaos-mesh.org/docs/development_guides/development_overview) useful. |
dcalvin
reviewed
Jun 16, 2020
CONTRIBUTING.md
Outdated
|
|
||
| ## Getting Help | ||
|
|
||
| If you have a question about Chaos Mesh or have encountered problems using it, [raise an issue in Github](https://github.com/pingcap/chaos-mesh/issues) or join us the #sig-chaos-mesh channel in the [TiDB Community](https://pingcap.com/tidbslack) slack workspace.. |
yeya24
reviewed
Jun 16, 2020
CONTRIBUTING.md
Outdated
|
|
||
| ### Step 1: Make the change | ||
|
|
||
| 1. Fork the Chaos Mesh repo, and then clone it to your local: |
There was a problem hiding this comment.
to your local sounds weird.
CONTRIBUTING.md
Outdated
| ### Step 3: Run e2e test | ||
|
|
||
| Chaos Mesh code must pass e2e test before being submitted. Before started, you must have [Docker](https://www.docker.com/get-started/) installed and running. | ||
|
|
There was a problem hiding this comment.
I am wondering whether we really need to add this step. Running e2e locally is not easy and it is really slow...
For users who want to do contributions, open a pr and run e2e test via Jenkins is much more convenient
Gallardot
reviewed
Jun 17, 2020
CONTRIBUTING.md
Outdated
|
|
||
| Before starting work on something major, please reach out to us via GitHub, Slack, email, etc. We will make sure no one else is already working on it and ask you to open a GitHub issue. Also, we will provide necessary guidance should you need it. | ||
|
|
||
| Specifically, if you want to develop a specific chaos type, åyou may also find [Development Guide](https://chaos-mesh.org/docs/development_guides/development_overview) useful. |
There was a problem hiding this comment.
Suggested change
| Specifically, if you want to develop a specific chaos type, åyou may also find [Development Guide](https://chaos-mesh.org/docs/development_guides/development_overview) useful. | |
| Specifically, if you want to develop a specific chaos type, you may also find [Development Guide](https://chaos-mesh.org/docs/development_guides/development_overview) useful. |
Signed-off-by: cwen0 <[email protected]>
Yisaer
approved these changes
Jun 17, 2020
fewdan
approved these changes
Jun 17, 2020
shonge
pushed a commit
to shonge/chaos-mesh
that referenced
this pull request
Jul 7, 2020
Signed-off-by: shonge <[email protected]>
sjwsl
pushed a commit
to sjwsl/chaos-mesh
that referenced
this pull request
May 6, 2021
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.
Signed-off-by: cwen0 [email protected]
What problem does this PR solve?
Add contributing guidelines and this pr base one #631 ,