-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add DCO descriptions in CONTRIBUTING file. [skip CI]
- Loading branch information
Showing
2 changed files
with
53 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -31,32 +31,32 @@ If you would like to contribute code to Dora SSR, please follow these steps: | |
|
||
1. **Fork the Project**: | ||
|
||
Fork the project repository. | ||
Fork the project repository. | ||
|
||
2. **Branch Creation**: | ||
|
||
Create a new branch locally to make changes. | ||
Create a new branch locally to make changes. | ||
|
||
3. **Build from Source**: | ||
|
||
Familiarize yourself with the project's compile-from-source process by referring to the [Build-from-Source Documentation](https://dora-ssr.net/docs/tutorial/dev-configuration). | ||
Familiarize yourself with the project's compile-from-source process by referring to the [Build-from-Source Documentation](https://dora-ssr.net/docs/tutorial/dev-configuration). | ||
|
||
4. **Coding**: | ||
|
||
Write the code and ensure it adheres to the project's coding standards. | ||
Write the code and ensure it adheres to the project's coding standards. | ||
|
||
**Coding Style Guidelines:** | ||
**Coding Style Guidelines:** | ||
|
||
- We adhere to a coding style to maintain consistency and readability across the project. Our style is defined in the clang-format config file located [here](Tools/Format/.clang-format). | ||
- Before submitting your code, please ensure running clang-format on your code. | ||
- We adhere to a coding style to maintain consistency and readability across the project. Our style is defined in the clang-format config file located [here](Tools/Format/.clang-format). | ||
- Before submitting your code, please ensure running clang-format on your code. | ||
|
||
5. **Commit and Push**: | ||
|
||
Commit the changes and push them to your forked repository. | ||
Commit the changes and push them to your forked repository. | ||
|
||
6. **Submit a Pull Request**: | ||
|
||
Create a Pull Request, describing your changes and their rationale in detail. | ||
Create a Pull Request, describing your changes and their rationale in detail. | ||
|
||
<br> | ||
|
||
|
@@ -66,6 +66,23 @@ Documentation is crucial to the success of any open-source project. If you find | |
|
||
<br> | ||
|
||
## Developer Certificate of Origin (DCO) | ||
|
||
By contributing to this project, you agree to the terms of the Developer Certificate of Origin. This means that: | ||
|
||
1. The code you are submitting is your own or you have permission to contribute it. | ||
2. You agree to license your contribution under the same license as the project. | ||
|
||
To indicate that you accept these terms, you must include a `Signed-off-by` line in your commit message: | ||
|
||
``` | ||
Signed-off-by: Your Name [email protected] | ||
``` | ||
|
||
You can add this automatically by running `git commit -s` when you make a commit. | ||
|
||
<br> | ||
|
||
## Community Support | ||
|
||
You can provide support to the community by answering questions, providing tutorials, and sharing example projects. If you have any resources that can help other developers, please share them in related community forums and chat rooms. | ||
|
@@ -74,4 +91,4 @@ You can provide support to the community by answering questions, providing tutor | |
|
||
------ | ||
|
||
We hope this contribution guide helps you get started with contributing to Dora SSR. Thank you again for your support, and we look forward to your contributions! | ||
We hope this contribution guide helps you get started with contributing to Dora SSR. Thank you again for your support, and we look forward to your contributions! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,32 +32,32 @@ | |
|
||
1. **Fork 项目**: | ||
|
||
Fork 项目仓库。 | ||
Fork 项目仓库。 | ||
|
||
2. **创建分支**: | ||
|
||
在本地创建一个新的分支,以便进行更改。 | ||
在本地创建一个新的分支,以便进行更改。 | ||
|
||
3. **从源代码构建**: | ||
|
||
通过参考[从源代码构建的文档](https://dora-ssr.net/zh-Hans/docs/tutorial/dev-configuration),熟悉项目从源代码编译的过程。 | ||
通过参考[从源代码构建的文档](https://dora-ssr.net/zh-Hans/docs/tutorial/dev-configuration),熟悉项目从源代码编译的过程。 | ||
|
||
4. **进行编码**: | ||
|
||
编写代码并确保代码符合项目的编码规范。 | ||
编写代码并确保代码符合项目的编码规范。 | ||
|
||
**编码风格指南:** | ||
**编码风格指南:** | ||
|
||
- 我们希望遵循同一种编码书写的风格,以保持项目的一致性和可读性。我们的风格定义在位于[此处](Tools/Format/.clang-format)的 clang-format 配置文件中。 | ||
- 提交代码之前,请确保对代码运行 clang-format 对代码做格式化的处理。 | ||
- 我们希望遵循同一种编码书写的风格,以保持项目的一致性和可读性。我们的风格定义在位于[此处](Tools/Format/.clang-format)的 clang-format 配置文件中。 | ||
- 提交代码之前,请确保对代码运行 clang-format 对代码做格式化的处理。 | ||
|
||
5. **提交和推送**: | ||
|
||
提交更改并将它们推送到您的 fork 仓库。 | ||
提交更改并将它们推送到您的 fork 仓库。 | ||
|
||
6. **提交 Pull Request**: | ||
|
||
创建一个 Pull Request,详细描述你的更改及其理由。 | ||
创建一个 Pull Request,详细描述你的更改及其理由。 | ||
|
||
<br> | ||
|
||
|
@@ -67,6 +67,23 @@ | |
|
||
<br> | ||
|
||
## 开发者认证协议 (DCO) | ||
|
||
通过为这个项目做出贡献,您同意开发者认证协议的条款。这意味着: | ||
|
||
1. 您提交的代码是您自己的,或者您有权贡献它。 | ||
2. 您同意将您的贡献在与项目相同的许可证下进行许可。 | ||
|
||
为了表明您接受这些条款,您必须在提交信息中包含一行 `Signed-off-by`: | ||
|
||
``` | ||
Signed-off-by: Your Name [email protected] | ||
``` | ||
|
||
您可以在提交时运行 `git commit -s` 来自动添加这一行。 | ||
|
||
<br> | ||
|
||
## 社区支持 | ||
|
||
  您可以通过回答问题、提供教程和示例项目等方式为社区提供支持。如果您有任何可以帮助其他开发者的资源,请分享在社区相关的论坛和聊天室中。 | ||
|