Skip to content

Commit 3554d1e

Browse files
committed
Add README in English.
1 parent 97cc0e9 commit 3554d1e

File tree

2 files changed

+51
-17
lines changed

2 files changed

+51
-17
lines changed

README-zh.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# QuecPython_lib_bundles 代码提交说明
2+
3+
[[英文](./README.md)]
4+
5+
## 目录结构示例
6+
7+
```
8+
.
9+
|-- README.md --- QuecPython_lib_bundles 代码提交说明
10+
|-- images --- 存储 md 文件引用的图片
11+
| |-- ads1115 --- 以库的名称建立文件夹,分类存储图片
12+
| `-- bmp280 --- 同上
13+
`-- libraries --- 存储库代码和文档
14+
|-- ads1115 --- 以库的名称建立文件夹,分类存储库代码和文档
15+
| |-- README.md --- 应用指导文档
16+
| |-- ads1115.py --- 库代码
17+
| `-- ads1115_demo.py --- demo示例
18+
`-- bmp280 --- 同上
19+
|-- README.md
20+
|-- bmp280.py
21+
`-- bmp280_demo.py
22+
```
23+
24+
> 代码贡献者请严格遵守该目录结构的约束。
25+
26+
## 代码提交
27+
28+
- 请先fork本仓库至个人账号,贡献的代码提交至仓库的dev分支,而后向源仓库的dev分支提PR,管理员审核通过后,合入到源仓库dev分支,并定期同步到master分支。
29+
30+
- 使用`git config commit.template ./commit.template`命令配置日志提交模板,使用`git commit`命令(不携带任何参数)进行提交,以便更好地遵守模板的规范。
31+
32+
- 代码提交者的git配置的邮箱请保证真实有效,以便管理员与其沟通。

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
1-
# QuecPython_lib_bundles 代码提交说明
1+
# QuecPython_lib_bundles Code Submission Guidelines
22

3-
## 目录结构示例
3+
[[中文](./README-zh.md)]
4+
5+
## Directory Structure Example
46

57
```
68
.
7-
|-- README.md --- QuecPython_lib_bundles 代码提交说明
8-
|-- images --- 存储 md 文件引用的图片
9-
| |-- ads1115 --- 以库的名称建立文件夹,分类存储图片
10-
| `-- bmp280 --- 同上
11-
`-- libraries --- 存储库代码和文档
12-
|-- ads1115 --- 以库的名称建立文件夹,分类存储库代码和文档
13-
| |-- README.md --- 应用指导文档
14-
| |-- ads1115.py --- 库代码
15-
| `-- ads1115_demo.py --- demo示例
16-
`-- bmp280 --- 同上
9+
|-- README.md --- QuecPython_lib_bundles Code Submission Guidelines
10+
|-- images --- Stores images referenced in the markdown files
11+
| |-- ads1115 --- Create folders based on library names to categorize images
12+
| `-- bmp280 --- Same as above
13+
`-- libraries --- Stores library code and documentation
14+
|-- ads1115 --- Create folders based on library names to categorize library code and documentation
15+
| |-- README.md --- Application guide document
16+
| |-- ads1115.py --- Library code
17+
| `-- ads1115_demo.py --- Demo
18+
`-- bmp280 --- Same as above
1719
|-- README.md
1820
|-- bmp280.py
1921
`-- bmp280_demo.py
2022
```
2123

22-
> 代码贡献者请严格遵守该目录结构的约束。
24+
> Code contributors are required to strictly adhere to this directory structure.
2325
24-
## 代码提交
26+
## Code Submission
2527

26-
- 请先fork本仓库至个人账号,贡献的代码提交至仓库的dev分支,而后向源仓库的dev分支提PR,管理员审核通过后,合入到源仓库dev分支,并定期同步到master分支。
28+
- Please fork this repository to your personal account. Contribute your code to the dev branch of your own fork. Then, create a pull request (PR) from your dev branch to the dev branch of the source repository. After the PR is reviewed and approved by the administrators, it will be merged into the source repository's dev branch and periodically synchronized to the master branch.
2729

28-
- 使用`git config commit.template ./commit.template`命令配置日志提交模板,使用`git commit`命令(不携带任何参数)进行提交,以便更好地遵守模板的规范。
30+
- Use the `git config commit.template ./commit.template` command to configure the commit template. When making commits with the `git commit` command (without any parameters), follow the template for better adherence to commit message guidelines.
2931

30-
- 代码提交者的git配置的邮箱请保证真实有效,以便管理员与其沟通。
32+
- Make sure your git configuration email is accurate and valid for effective communication with the administrators.

0 commit comments

Comments
 (0)