fanhuadesenlinnn/cloudpods
1
0
Fork 0
mirror of https://hubproxy.babadafafafafa.cn/https://github.com/yunionio/cloudpods.git synced 2026-09-20 08:03:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix: improve documentation

Browse Source
This commit is contained in:
Qiu Jian
2021-06-05 03:33:55 +08:00
parent ee82adba4f
commit 2cc64af6fc
4 changed files with 108 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
CONTRIBUTING_zh.md Normal file
View File

@@ -0,0 +1,50 @@
# 贡献指南
[English](CONTRIBUTING.md) | [中文](CONTRIBUTING_zh.md)
你有很多事情可以做，使得Cloudpods变得更完善，
## 让别人知道Cloudpods
First of all, the easiest way to contribute to Cloudpods is to let more people known Cloudpods. To share your experience of Cloudpods. Hopefully Cloudpods may help resolve the issues in their daily jobs.
## 报告BUG
Cloudpos is an infrastructure management tool. Even though it has been thourougly tested and codes have been peer reviwed before merge, due to various reasons, you may still encounter bugs when using Cloudpods. This is frustrating. However, please do not hesitate to submit a issue at Github. The issue may help developers to improve the codes and make Cloudpods more and more robust. Meanwhile, the answer to the issues may also help others who meet the same bugs.
## 回答问题
You may answer issues at Github and help those who encounter issues when using Cloudpods. Sometimes, the issues are not due to bugs in codes but simplely because of misconfigurations, environment or misunderstandings.
## 贡献代码
我们非常欢迎和感谢开发者向项目做贡献，流程细节请查看 [CONTRIBUTING](https://docs.yunion.io/zh/docs/contribute/contrib/).
### 修复BUG
You may help solve bugs by submiting patches.
### 开发新的功能特性
You may help improve the codes of Cloudpods, including:
* Develop new features for Cloudpods
* Recode some part of Cloudpods so as to make the code easier to be understood, or less error-prone, or more efficient
## 文档化
You may help improve documentations of Cloudpds by directly make pull request to documentations. Once the Pull Request is accepted and merged, the documentations will be updated immediately.
## 翻译
You may help translate the UI texts or documents of Cloudpds to other languages. Currently, we support Simplified Chinese and English.
## 写文章
You are also welcome to write articles about Cloudpods and sharing your experience with others. The content of the articles may include the following but not be limited to:
* Your user experiences with Cloudpods
* Your opinion about the direction and area of Cloudpods
* Comparison with other cloud platforms
* Benchmarks