From 694e3d107efb8e6abd9b3fa824e07816a1823e58 Mon Sep 17 00:00:00 2001 From: Xudong Guo Date: Tue, 9 Jan 2024 10:54:04 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20add=20contribute?= =?UTF-8?q?=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .all-contributorsrc | 4 +- README.md | 12 ++++- docs/en-us/contribute.md | 95 +++++++++++++++++++++++++++++++++++++++- docs/zh-cn/contribute.md | 52 +++++++++++++++++++++- 4 files changed, 159 insertions(+), 4 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index ad487672..f2a98b13 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -4,7 +4,9 @@ "repoType": "github", "repoHost": "https://github.com", "files": [ - "README.md" + "README.md", + "docs/en-us/contribute.md", + "docs/zh-cn/contribute.md" ], "imageSize": 100, "commit": true, diff --git a/README.md b/README.md index 16d0e57d..2cfbee9f 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,17 @@ Source binary: ## Contribute ๐Ÿค -Feel free to open issues and pull requests. Any feedback is highly appreciated! I'd be grateful if you can give me some feedback. +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: + +- Reporting a bug +- Discussing the current state of the code +- Submitting a fix +- Proposing new features +- Becoming a maintainer + +Feel free to open [issue](https://github.com/sunny0826/kubecm/issues/new) and [pull requests](https://github.com/sunny0826/kubecm/pulls). Any feedback is highly appreciated! + +Be sure to follow our [Community Guidelines](https://kubecm.cloud/en-us/contribute) when submitting your PR and interacting with other folks in this repository. ## Star History ๐Ÿ“ˆ diff --git a/docs/en-us/contribute.md b/docs/en-us/contribute.md index 6169be4a..ff241fe2 100644 --- a/docs/en-us/contribute.md +++ b/docs/en-us/contribute.md @@ -1,5 +1,98 @@ +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: + +- Reporting a bug +- Discussing the current state of the code +- Submitting a fix +- Proposing new features +- Becoming a maintainer + Feel free to open [issue](https://github.com/sunny0826/kubecm/issues/new) and [pull requests](https://github.com/sunny0826/kubecm/pulls). Any feedback is highly appreciated! -## Star History +## Contribution process + +Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests: + +1. Fork the repo and create your branch from `master`. +2. If you've added code that should be tested, add tests. Please run the `make build` and `make test` commands. +3. If you've changed Commands or Parameters, update the documentation. run `make doc-gen` to generate new documentation. +4. Ensure the CI passes. +5. Issue that pull request! + +## Any contributions you make will be under the Software License + +In short, when you submit code changes, your submissions are understood to be under the same [LICENSE](https://github.com/sunny0826/kubecm/blob/master/LICENSE) that covers the project. We use the Apache 2.0 license. Feel free to contact the maintainers if that's a concern. + +## Report bugs +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/sunny0826/kubecm/issues/new); it's that easy! + +### Write bug reports with detail, background, and sample code + +**Great Bug Reports** tend to have: + +- A quick summary and/or background +- Steps to reproduce + - Be specific! + - Give sample code if you can. +- What you expected would happen +- What actually happens +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) + +People *love* thorough bug reports. + +## License +By contributing, you agree that your contributions will be licensed under its [LICENSE](LICENSE). + + +## Star History ๐Ÿ“ˆ [![Star History Chart](https://api.star-history.com/svg?repos=sunny0826/kubecm&type=Date)](https://star-history.com/#sunny0826/kubecm) + +## Contributors โœจ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Xudong Guo
Xudong Guo
๐Ÿ’ป ๐Ÿ“– ๐Ÿšง		Cheng Wang
Cheng Wang
๐Ÿ’ป		Neko Ayaka
Neko Ayaka
๐Ÿ’ป		l1b0k
l1b0k
๐Ÿ’ป		Zhizhen He
Zhizhen He
๐Ÿ’ป		Hang Yu
Hang Yu
๐Ÿ’ป		dennislapchenko
dennislapchenko
๐Ÿ’ป
cnfatal
cnfatal
๐Ÿ’ป		Se7en
Se7en
๐Ÿ’ป		Yarden Shoham
Yarden Shoham
๐Ÿ’ป โš ๏ธ		Vimsucks
Vimsucks
๐Ÿ’ป		Shunsuke Suzuki
Shunsuke Suzuki
๐Ÿ’ป		YS Liu
YS Liu
๐Ÿ’ป		Sarun Nuntaviriyakul
Sarun Nuntaviriyakul
๐Ÿ’ป
Max Anderson
Max Anderson
๐Ÿ’ป		Mario Fritschen
Mario Fritschen
๐Ÿ’ป		Jia Sui
Jia Sui
๐Ÿ’ป		AdamRussak
AdamRussak
๐Ÿ’ป
+ + Add your contributions + +
+ + + + + \ No newline at end of file diff --git a/docs/zh-cn/contribute.md b/docs/zh-cn/contribute.md index bba385da..133e7b75 100644 --- a/docs/zh-cn/contribute.md +++ b/docs/zh-cn/contribute.md @@ -1,5 +1,55 @@ ๆฌข่ฟŽๅœจ [issue](https://github.com/sunny0826/kubecm/issues/new) ไธญไธŽไฝœ่€…ไบคๆตๆˆ–ๆไบค [pull requests](https://github.com/sunny0826/kubecm/pulls)๏ผŒๆ‚จ็š„ๅ้ฆˆๅฏนๆœฌ้กน็›ฎ็š„ๅฅๅบทๅ‘ๅฑ•ๆ˜ฏๅๅˆ†้‡่ฆ็š„ใ€‚ -## Star History +## Star History ๐Ÿ“ˆ [![Star History Chart](https://api.star-history.com/svg?repos=sunny0826/kubecm&type=Date)](https://star-history.com/#sunny0826/kubecm) + +## ่ดก็Œฎ่€… โœจ + +ๆ„Ÿ่ฐข่ฟ™ไบ›ๆฐๅ‡บ็š„ไบบ ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Xudong Guo
Xudong Guo
๐Ÿ’ป ๐Ÿ“– ๐Ÿšง		Cheng Wang
Cheng Wang
๐Ÿ’ป		Neko Ayaka
Neko Ayaka
๐Ÿ’ป		l1b0k
l1b0k
๐Ÿ’ป		Zhizhen He
Zhizhen He
๐Ÿ’ป		Hang Yu
Hang Yu
๐Ÿ’ป		dennislapchenko
dennislapchenko
๐Ÿ’ป
cnfatal
cnfatal
๐Ÿ’ป		Se7en
Se7en
๐Ÿ’ป		Yarden Shoham
Yarden Shoham
๐Ÿ’ป โš ๏ธ		Vimsucks
Vimsucks
๐Ÿ’ป		Shunsuke Suzuki
Shunsuke Suzuki
๐Ÿ’ป		YS Liu
YS Liu
๐Ÿ’ป		Sarun Nuntaviriyakul
Sarun Nuntaviriyakul
๐Ÿ’ป
Max Anderson
Max Anderson
๐Ÿ’ป		Mario Fritschen
Mario Fritschen
๐Ÿ’ป		Jia Sui
Jia Sui
๐Ÿ’ป		AdamRussak
AdamRussak
๐Ÿ’ป
+ + Add your contributions + +
+ + + + + \ No newline at end of file