Skip to content

Commit 0b8d0a8

Browse files
YDX-2147483647YDX-2147483647
committed
Localize CONTRIBUTING.md
Relates-to: #3
1 parent 10959c5 commit 0b8d0a8

File tree

1 file changed

+107
-91
lines changed

1 file changed

+107
-91
lines changed

‎CONTRIBUTING.md‎

Lines changed: 107 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,134 @@
11
<!-- markdownlint-disable MD024 -->
2-
# Contribution Guidelines
2+
# 贡献者指南
33

4-
Thanks for your interest in contributing to our project. This page will give you a quick overview of how things are organized and, most importantly, how to get involved. Everyone is welcome to contribute, and we value everybody's contribution.
4+
感谢你为本项目付出宝贵时间！
55

6-
## Table of contents
6+
下面会介绍本项目如何组织，想更改时应该怎样操作。
77

8-
1. [Add a project](#add-a-project)
9-
2. [Update a project](#update-a-project)
10-
3. [Improve metadata collection](#improve-metadata-collection)
11-
4. [Improve markdown generation](#improve-markdown-generation)
12-
5. [Create your own best-of list](#improve-markdown-generation)
13-
6. [Code of conduct](#code-of-conduct)
8+
> **Note** 下面大多只是指导性建议；如果你知道自己想做什么，跟着感觉走即可。
149
15-
## Add a project
10+
## 新增项目
1611

17-
If you like to suggest or add a project, choose one of the following ways:
12+
若要添加新项目，有如下两种方法。
1813

19-
- Suggest a project by opening an issue: Please use the suggest project template from the [issue page](https://github.com/YDX-2147483647/best-of-bits/issues/new/choose) and fill in the requested information.
20-
- Add a project by modifying the [projects.yaml](https://github.com/YDX-2147483647/best-of-bits/blob/main/projects.yaml) and submitting a pull request with your addition. This can also be done directly via the [Github UI](https://github.com/YDX-2147483647/best-of-bits/edit/main/projects.yaml).
14+
- 提请修改：访问[议题页面](https://github.com/YDX-2147483647/best-of-bits/issues/new/choose)，选择类别，填写信息。
15+
- 直接编辑：在[`projects.yaml`](https://github.com/YDX-2147483647/best-of-bits/edit/main/projects.yaml)中增减项目，然后提交拉取请求。（可[直接用 GitHub UI 操作](https://github.com/YDX-2147483647/best-of-bits/edit/main/projects.yaml)）
2116

22-
Before opening an issue or pull request, please ensure that you adhere to the following guidelines:
17+
提交议题、拉取请求前有如下常见问题。
18+
19+
- 请确保这一项目尚未被收录，而且还没有其他人请求。
20+
21+
已收录的项目在 [projects.yaml](https://github.com/YDX-2147483647/best-of-bits/blob/main/projects.yaml)、[README.md](https://github.com/YDX-2147483647/best-of-bits/blob/main/README.md) 两个文件，其他人的请求在[议题](https://github.com/YDX-2147483647/best-of-bits/issues?q=is%3Aopen+label%3Aadd-project)，都可以搜索。
22+
23+
- 不要直接改`README.md`，而是改`projects.yaml`。
24+
25+
`README.md`内容是每周 [GitHub Actions](https://github.com/YDX-2147483647/best-of-bits/actions/workflows/update-best-of-list.yml) 自动生成的，不用直接编辑。
26+
27+
- `projects.yaml`采用 [YAML](https://quickref.me/yaml) 格式，内容见[项目属性](#项目属性)一节。
28+
29+
下面是个例子，可照猫画虎。
2330

24-
- Please make sure that the project was not already added or suggested to this best-of list. You can ensure this by searching the projects.yaml, the Readme, and the issue list.
25-
- Add the project to the `projects.yaml` and never to the `README.md` file directly. Use the yaml format and the properties documented in the [project properties](#project-properties) section below to add a new project, for example:
2631
```yaml
27-
- name: Tensorflow
28-
github_id: tensorflow/tensorflow
29-
pypi_id: tensorflow
30-
conda_id: tensorflow
31-
labels: ["tensorflow"]
32-
category: ml-frameworks
32+
- name: BIT101
33+
homepage: https://bit101.cn
34+
github_id: flwfdd/BIT101
35+
category: website
36+
labels: [Web, python]
3337
```
34-
- Please create an individual issue or pull request for each project.
35-
- Please use the following title format for the issue or pull request: `Add project: project-name`.
36-
- If a project doesn't fit into any of the pre-existing categories, it should go under the `Others` category by not assigning any category. You can also suggest a new category via the add or update category template on the [issue page](https://github.com/YDX-2147483647/best-of-bits/issues/new/choose).
3738
38-
## Update a project
39+
- 如果要添加好几个独立的项目，请分成多个议题／拉取请求。
3940
40-
If you like to suggest or contribute a project update, choose one of the following ways:
41+
- 议题、拉取请求的标题请以“新增项目：”开头。
4142
42-
- Suggest a project update by opening an issue: Please use the update project template from the [issue page](https://github.com/YDX-2147483647/best-of-bits/issues/new/choose) and fill in the requested information.
43-
- Update a project by modifying the [projects.yaml](https://github.com/YDX-2147483647/best-of-bits/blob/main/projects.yaml) and submitting a pull request with your changes. This can also be done directly via the [Github UI](https://github.com/YDX-2147483647/best-of-bits/edit/main/projects.yaml).
43+
直接使用模板即可。
4444
45-
Before opening an issue or pull request, please ensure that you adhere to the following guidelines:
45+
- 如果项目哪类也不算，`category`（类别）可以留空。
4646

47-
- Only update the project in the `projects.yaml` and never to the `README.md` file directly. Use the yaml format and the properties documented in the [project properties](#project-properties) section below to update a new project.
48-
- Please create an individual issue or pull request for each project.
49-
- Please use the following title format for the issue or pull request: `Update project: project-name`.
47+
另外可以[新建议题](https://github.com/YDX-2147483647/best-of-bits/issues/new/choose)添加类别。
5048

51-
## Project properties
49+
## 更改项目
5250

53-
<table>
54-
<tr>
55-
<th>Property</th>
56-
<th>Description</th>
57-
</tr>
58-
<tr>
59-
<td><code>name</code></td>
60-
<td>Name of the project. This name is required to be unique on the best-of list.</td>
61-
</tr>
62-
<tr>
63-
<td><code>github_id</code></td>
64-
<td>Github ID of the project based on user or organization and the repository name, e.g. <code>best-of-lists/best-of-generator</code>.</td>
65-
</tr>
66-
<tr>
67-
<td colspan="2"><b>Optional Properties:</b></td>
68-
</tr>
69-
<tr>
70-
<td><code>category</code></td>
71-
<td>Category that this project is most related to. You can find all available category IDs in the <code>projects.yaml</code> file. The project will be sorted into the <code>Others</code> category if no category is provided.</td>
72-
</tr>
73-
<tr>
74-
<td><code>labels</code></td>
75-
<td>List of labels that this project is related to. You can find all available label IDs in the <code>projects.yaml</code> file.</td>
76-
</tr>
77-
<tr>
78-
<td colspan="2"><b>Supported Package Managers:</b></td>
79-
</tr>
80-
<tr>
81-
<td><code>pypi_id</code></td>
82-
<td>Project ID on the python package index (<a href="https://pypi.org">PyPi</a>).</td>
83-
</tr>
84-
<tr>
85-
<td><code>conda_id</code></td>
86-
<td>Project ID on the <a href="https://anaconda.org">conda package manager</a>. If the main package is provided on a different channel, prefix the ID with the given channel: e.g. <code>conda-forge/tensorflow</code></td>
87-
</tr>
88-
<tr>
89-
<td><code>npm_id</code></td>
90-
<td>Project ID on the Node package manager (<a href="https://www.npmjs.com">npm</a>).</td>
91-
</tr>
92-
<tr>
93-
<td><code>dockerhub_id</code></td>
94-
<td>Project ID on the <a href="https://hub.docker.com">Docker Hub container registry</a>. </td>
95-
</tr>
96-
<tr>
97-
<td><code>maven_id</code></td>
98-
<td>Artifact ID on <a href="https://mvnrepository.com">Maven central</a>, e.g. <code>org.apache.flink:flink-core</code>. </td>
99-
</tr>
100-
</table>
51+
若要更改现有项目，有如下两种方法。（和[新增项目](#新增项目)一样）
10152

102-
Please refer to the [best-of-generator documentation](https://github.com/best-of-lists/best-of-generator#project-properties) for a complete and up-to-date list of supported project properties.
53+
- 提请修改：访问[议题页面](https://github.com/YDX-2147483647/best-of-bits/issues/new/choose)，选择类别，填写信息。
54+
- 直接编辑：在[`projects.yaml`](https://github.com/YDX-2147483647/best-of-bits/edit/main/projects.yaml)中增减项目，然后提交拉取请求。（可[直接用 GitHub UI 操作](https://github.com/YDX-2147483647/best-of-bits/edit/main/projects.yaml)）
10355

104-
## Improve metadata collection
56+
提交议题、拉取请求前有如下常见问题。
10557

106-
If you like to contribute to or share suggestions regarding the project metadata collection, please refer to the [best-of-generator](https://github.com/best-of-lists/best-of-generator) repository.
58+
- 不要直接改`README.md`，而是改`projects.yaml`。
10759

108-
## Improve markdown generation
60+
- `projects.yaml`采用 [YAML](https://quickref.me/yaml) 格式，内容见[项目属性](#项目属性)一节。
61+
62+
- 如果要添加好几个独立的项目，请分成多个议题／拉取请求。
63+
64+
- 议题、拉取请求的标题请以“更改项目：”开头。
65+
66+
## 项目属性
67+
68+
> **Note**
69+
> 最新完整列表请参考 [best-of-generator 文档](https://github.com/best-of-lists/best-of-generator#project-properties)。
70+
71+
<table>
72+
<thead>
73+
<tr>
74+
<th>属性</th>
75+
<th>描述</th>
76+
</tr>
77+
</thead>
78+
<tbody>
79+
<tr>
80+
<td><code>name</code></td>
81+
<td>项目名称。必须和其它项目不同。</td>
82+
</tr>
83+
<tr>
84+
<td><code>github_id</code></td>
85+
<td>GitHub ID，由作者名（或组织名）、仓库名组成，例如<code>best-of-lists/best-of-generator</code>。</td>
86+
</tr>
87+
<tr>
88+
<td colspan="2"><strong>可选属性：</strong></td>
89+
</tr>
90+
<tr>
91+
<td><code>category</code></td>
92+
<td>类别的 ID。若项目涉及好几类，请只写最相关的那一类。具体 ID
93+
请参考<code>projects.yaml</code>里的<code>categories</code>。若不填，则会归入“Others”。</td>
94+
</tr>
95+
<tr>
96+
<td><code>labels</code></td>
97+
<td>项目相关的标签的列表。具体 ID
98+
请参考<code>projects.yaml</code>里的<code>labels</code>。</td>
99+
</tr>
100+
<tr>
101+
<td colspan="2"><strong>支持的包管理器：</strong></td>
102+
</tr>
103+
<tr>
104+
<td><code>pypi_id</code></td>
105+
<td>Python Package Index（<a href="https://pypi.org">PyPI</a>）上的项目 ID。</td>
106+
</tr>
107+
<tr>
108+
<td><code>conda_id</code></td>
109+
<td><a href="https://anaconda.org">Conda package manager</a> 上的项目 ID。如果主包在别的 channel，要前缀 channel，比如 <code>conda-forge/tensorflow</code>。</td>
110+
</tr>
111+
<tr>
112+
<td><code>npm_id</code></td>
113+
<td>Node package manager（<a href="https://www.npmjs.com">npm</a>）上的项目 ID。</td>
114+
</tr>
115+
<tr>
116+
<td><code>dockerhub_id</code></td>
117+
<td><a href="https://hub.docker.com">Docker Hub container registry</a> 上的项目 ID。</td>
118+
</tr>
119+
<tr>
120+
<td><code>maven_id</code></td>
121+
<td><a href="https://mvnrepository.com">Maven central</a> 上的 artifact ID，例如<code>org.apache.flink:flink-core</code>。</td>
122+
</tr>
123+
</tbody>
124+
</table>
109125

110-
If you like to contribute to or share suggestions regarding the markdown generation, please refer to the [best-of-generator](https://github.com/best-of-lists/best-of-generator) repository.
126+
## 上游项目
111127

112-
## Create your own best-of list
128+
除了项目，本列表还涉及收集元数据、生成 markdown 等。这方面的贡献请移步 [best-of-generator](https://github.com/best-of-lists/best-of-generator) 仓库或我们克隆的 [best-of-update-action](https://github.com/YDX-2147483647/best-of-update-action/tree/ascii-description) 仓库。
113129

114-
If you want to create your own best-of list, we strongly recommend to follow [this guide](https://github.com/best-of-lists/best-of/blob/main/create-best-of-list.md). With this guide, it will only take about 3 minutes to get you started. It is already set-up to automatically run the best-of generator via our Github Action and includes other useful template files.
130+
若您想自己创建一个 best-of list，请参考[官方教程](https://github.com/best-of-lists/best-of/blob/main/create-best-of-list.md)，大概[需要三分钟](https://xkcd.com/2767/)。完成后 GitHub Actions 可以自动运行 best-of-generator。
115131

116-
## Code of Conduct
132+
## 贡献者公约
117133

118-
All members of the project community must abide by the [Contributor Covenant, version 2.1](./.github/CODE_OF_CONDUCT.md). Only by respecting each other we can develop a productive, collaborative community. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer.
134+
参与此项目即代表遵守[贡献者公约](https://github.com/YDX-2147483647/best-of-bits/blob/main/.github/CODE_OF_CONDUCT.md)。相互尊重才有我们才能合作干实事。辱骂、骚扰或其他不可接受的行为可向社区监督人报告。

0 commit comments

Comments
 (0)