mirror/Dominion
2
0
Fork 0
mirror of https://github.com/ColdeZhang/Dominion.git synced 2024-12-18 20:58:57 +08:00
Code Issues Actions Packages Projects Releases 43 Wiki Activity

更新readme

Browse Source
This commit is contained in:
zhangyuheng 2024-09-10 16:55:25 +08:00
parent 35ed249fbb
commit c3a2b5db13
3 changed files with 27 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@ -1,22 +1,41 @@
# Contributing to Dominion
Thank you for considering contributing to Dominion! We welcome contributions from everyone. By participating in this project, you agree to abide by our code of conduct.
Thank you for considering contributing to Dominion! We welcome contributions from everyone. By participating in this
project, you agree to abide by our code of conduct.
## How to Contribute
### 🪲Reporting Bugs
If you find a bug, please report it by opening an issue on our GitHub repository. Include as much detail as possible, including steps to reproduce the issue, the expected result, and the actual result.
If you find a bug, please report it by opening an issue on our GitHub repository. Include as much detail as possible,
including steps to reproduce the issue, the expected result, and the actual result.
### 💡Suggesting Enhancements
We welcome suggestions for new features or improvements. Please open an issue on our GitHub repository and describe the enhancement you would like to see, why you think it would be useful, and any other relevant information.
We welcome suggestions for new features or improvements. Please open an issue on our GitHub repository and describe the
enhancement you would like to see, why you think it would be useful, and any other relevant information.
### 🌐Translating
[![Crowdin](https://badges.crowdin.net/dominion/localized.svg)](https://crowdin.com/project/dominion)
#### **Translate Plugin Messages**
We welcome translations of our documentation & plugin messages. If you would like to help translation, please refer to the [Crowdin project](https://crowdin.com/project/dominion).
If you would like to help translation, please refer to
the [Crowdin project](https://crowdin.com/project/dominion) [![Crowdin](https://badges.crowdin.net/dominion/localized.svg)](https://crowdin.com/project/dominion).
#### **Translate Documentation**
1. Fork the repository & clone the repository to your local machine.
2. Create a new branch for your translation.
3. Translate the documentation or plugin messages.
4. Commit & Push your changes to your fork.
5. Open a pull request, wait for your pull request to be reviewed and merged.
Documentations are located in the `docs` directory. Translate the files in the language you want to contribute to.
- If the language you want to translate to does not exist, create a new directory with the language code (e.g., `zh-cn`
for Simplified Chinese).
- If the documentation is not up-to-date, please update it from the `zh-cn` directory.
- Don't forget to leave your name and contact information in `docs/YOUR_LANGUAGE_CODE/README.md` below.
## 🫴Getting Help

2
docs/en-us/README.md
View File

@ -24,7 +24,7 @@ at [GitHub ISSUE](https://github.com/ColdeZhang/Dominion/issues).
## Help translate this documentation
If you want to help us translate the documentation, please refer
to [CONTRIBUTING.md](https://github.com/ColdeZhang/Dominion/blob/master/CONTRIBUTING.md#translating).
to [CONTRIBUTING.md](https://github.com/ColdeZhang/Dominion/blob/master/CONTRIBUTING.md#translate-documentation).
❤ Thank you for your support and contribution! ❤

2
docs/zh-hk/README.md
View File

@ -21,6 +21,6 @@ Dominion 是一個完全開源、免費，專為高版本開發，面向未來
## 幫助翻譯本文檔
如果您想幫助翻譯本文檔，請參考 [翻譯指南](https://github.com/ColdeZhang/Dominion/blob/master/CONTRIBUTING.md#translating)。
如果您想幫助翻譯本文檔，請參考 [翻譯指南](https://github.com/ColdeZhang/Dominion/blob/master/CONTRIBUTING.md#translate-documentation)。
❤ 感謝您的支持和貢獻！ ❤