Skip to content

Commit 723c15c

Browse files
authored
CONTRIBUTING.md: update contributing guidelines for clarity and accuracy (#674)
* CONTRIBUTING.md: update contributing guidelines for clarity and accuracy * CONTRIBUTING.md: clarify repository hosting and contribution guidelines
1 parent 417648e commit 723c15c

File tree

1 file changed

+35
-20
lines changed

1 file changed

+35
-20
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,30 @@
1+
<div align="center">
2+
<a href="#参与开发">
3+
中文说明请点此跳转
4+
</a>
5+
</div>
6+
17
# Participate in development
28

3-
MineAdmin is an open source project and we welcome anyone to participate in its development. If you would like to participate in development, please read the following.
9+
MineAdmin is an open source project, and we welcome anyone to participate in its development. If you would like to participate in development, please read the following.
410

511
## Repository address
612

7-
Currently the source code repository is hosted on Github, and the front-end and back-end source code in the gitee repository is used as a mirror repository. The code is automatically synchronized every day. We do not support any kind of code submission.
8-
However, [documentation](https://doc.mineadmin.com/) is maintained on [code cloud repository](https://gitee.com/mineadmin/mineadmin-doc).
13+
Currently, the codebase is hosted on GitHub. The front-end and back-end code in the Gitee repository **are** read-only mirror repositories, automatically synchronized every day. We **do not accept** code submissions on Gitee.
14+
15+
>**Note**: Starting from version 3.0, both the front-end and back-end source code are located in the `/web` directory of this repository.
916
1017
### Github
1118

19+
* [MineAdmin Documentation](https://github.com/mineadmin/doc-v3)
1220
* [MineAdmin back-end source code](https://github.com/mineadmin/mineadmin)
13-
* [MineAdmin front-end source code](https://github.com/mineadmin/mineadmin-vue)
21+
* [MineAdmin front-end source code](https://github.com/mineadmin/MineAdmin/tree/master/web)
1422
* [MineAdmin kernel components](https://github.com/mineadmin/components)
1523

1624
### Gitee
1725

18-
* [MineAdmin Documentation](https://gitee.com/mineadmin/mineadmin-doc)
1926
* [MineAdmin backend source code](https://gitee.com/mineadmin/mineadmin)
20-
* [MineAdmin front-end source code](https://gitee.com/mineadmin/mineadmin-vue)
27+
* [MineAdmin front-end source code](https://gitee.com/mineadmin/mineadmin/tree/master/web)
2128

2229

2330
## What you can do
@@ -26,48 +33,55 @@ However, [documentation](https://doc.mineadmin.com/) is maintained on [code clou
2633

2734
* We will release some pending features in issues, if you are interested, you can leave a comment in issues, we will reply as soon as possible.
2835
* Comment replies help users who ask questions;
29-
* According to the content of [issues](https://github.com/mineadmin/mineadmin/issues), propose a reasonable solution; go to fix the bug or realize the function, and take [pull request](https://github.com/mineadmin/ mineadmin/pulls) to the MineAdmin repository.
36+
* According to the content of [issues](https://github.com/mineadmin/mineadmin/issues), propose a reasonable solution; go to fix the bug or realize the function, and take [pull request](https://github.com/mineadmin/mineadmin/pulls) to the MineAdmin repository.
3037
* Keep an eye on the progress and status of your own Pull Requests, in order to push your Pull Requests to be merged into the main repository as soon as possible;
3138
* Conduct Code Review on other people's Pull Requests, and give your suggestions and opinions.
3239
* Develop independent functional components based on others' or your own requirements;
3340
* Improve the [documentation](https://gitee.com/mineadmin/mineadmin-doc) to provide better usage instructions.
3441

3542
### Pull Request Guidelines
3643

37-
Although we regularly release features for development, you are more than welcome to suggest features that you would like to implement. You can submit your ideas in [issues](https://github.com/mineadmin/mineadmin/issues) and we will reply as soon as possible whether we accept them or not.
44+
Although we regularly release features for development, you are more than welcome to suggest features that you would like to implement. You can submit your ideas in [issues,](https://github.com/mineadmin/mineadmin/issues) and we will reply as soon as possible whether we accept them or not.
3845
Before submitting an issue, please check if a similar issue has already been posted.
3946

40-
* fork this repository to your Github account;
47+
* fork this repository to your GitHub account;
4148
* The format of the commit message should be [File Name]: Info about commit. (e.g.) README.md: Fix xxx bugs
4249
* Run `composer cs-fix` to format your code before committing it;
43-
* Run `composer an` for static code checking before committing;
44-
* Run `composer test` before submitting code.
50+
* Run `composer analyse` for static code checking before committing;
51+
* Run `composer test` before submitting code.
52+
* **Note:** !!!Do NOT run unit tests on any of your production environments, as they will delete or modify data!!!!
4553
* Make sure to create the PR as your functional branch, rather than committing changes directly on the master branch.
4654
* If your PR fixes a bug, please provide a description of the bug.
4755

4856
> 以下是中文说明
4957
---
58+
<div align="center">
59+
<a href="#participate-in-development">
60+
English instructions, click here to jump
61+
</a>
62+
</div>
5063

5164
# 参与开发
5265

5366
MineAdmin 是一个开源项目,我们欢迎任何人参与开发。如果你想参与开发,请阅读以下内容。
5467

5568
## 仓库地址
5669

57-
目前源代码仓库托管在 Github,码云仓库中的前后端源码作为镜像仓库。每天会自动同步代码。不支持任何形式的代码提交。
58-
但是 [文档](https://doc.mineadmin.com/) 是在[码云仓库](https://gitee.com/mineadmin/mineadmin-doc)上维护的。
70+
目前源代码仓库托管在 GitHub,码云仓库中的前后端源码作为镜像仓库。每天会自动同步代码。不支持任何形式的代码提交。
5971

60-
### Github
72+
>**注意**:自 3.0 版本起,前端与后端源码统一放在仓库的 `/web` 目录下。
6173
74+
### GitHub
75+
* [MineAdmin 文档](https://github.com/mineadmin/doc-v3)
6276
* [MineAdmin 后端源代码](https://github.com/mineadmin/mineadmin)
63-
* [MineAdmin 前端源代码](https://github.com/mineadmin/mineadmin-vue)
77+
* [MineAdmin 前端源代码](https://github.com/mineadmin/MineAdmin/tree/master/web)
6478
* [MineAdmin 内核组件](https://github.com/mineadmin/components)
6579

6680
### Gitee
6781

68-
* [MineAdmin 文档](https://gitee.com/mineadmin/mineadmin-doc)
82+
6983
* [MineAdmin 后端源代码](https://gitee.com/mineadmin/mineadmin)
70-
* [MineAdmin 前端源代码](https://gitee.com/mineadmin/mineadmin-vue)
84+
* [MineAdmin 前端源代码](https://gitee.com/mineadmin/mineadmin/tree/master/web)
7185

7286

7387
## 你可以做什么
@@ -80,7 +94,7 @@ MineAdmin 是一个开源项目,我们欢迎任何人参与开发。如果你
8094
* 关注自己提交 Pull Request 的进度和状态,以推动您的 Pull Request 尽快合入主仓库;
8195
* 对其他人提交的 Pull Request 进行 Code Review,并给出您的建议和看法。
8296
* 根据他人或自己的需求,研发独立的功能组件;
83-
* 完善[文档](https://gitee.com/mineadmin/mineadmin-doc),提供更好的使用说明。
97+
* 完善[文档](https://github.com/mineadmin/doc-v3),提供更好的使用说明。
8498

8599
### Pull Request 指南
86100

@@ -90,7 +104,8 @@ MineAdmin 是一个开源项目,我们欢迎任何人参与开发。如果你
90104
* fork 本仓库到你的 Github 账号下;
91105
* 提交信息的格式应为 [File Name]: Info about commit. (例如) README.md: Fix xxx bug
92106
* 提交代码前,请先执行 `composer cs-fix` 进行代码格式化;
93-
* 提交代码前,请先执行 `composer an` 进行代码静态检查;
94-
* 提交代码前,请先执行 `composer test` 进行单元测试;单元测试不要在您的任何生产环境上运行,因为它会删除添加数据;
107+
* 提交代码前,请先执行 `composer analyse` 进行代码静态检查;
108+
* 提交代码前,请先执行 `composer test` 进行单元测试;
109+
* **注意**: !!!单元测试不要在您的任何生产环境上运行,因为它会删除添加数据!!!;
95110
* 确保将 PR 创建为你的功能分支, 而不是 master 分支上直接提交修改。
96111
* 如果你的 PR 修复了 bug,请提供有关相关 bug 的描述。

0 commit comments

Comments
 (0)