Skip to content

Commit 940c707

Browse files
committed
Update README.md
Signed-off-by: Toomore Chiang <[email protected]>
1 parent 791affa commit 940c707

File tree

1 file changed

+57
-10
lines changed

1 file changed

+57
-10
lines changed

README.md

+57-10
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
1-
# COSCUP Volunteer
1+
# COSCUP Volunteer 志工平台
2+
3+
![GitHub](https://img.shields.io/github/license/COSCUP/COSCUP-Volunteer) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6869/badge)](https://bestpractices.coreinfrastructure.org/projects/6869)
24

3-
[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6869/badge)](https://bestpractices.coreinfrastructure.org/projects/6869)
5+
`English below`
46

57
COSCUP Volunteer 志工服務系統,主要解決招募、人員管理、行政流程建立。
68
[https://volunteer.coscup.org/](https://volunteer.coscup.org/)
79

8-
## License
10+
## 授權
911

1012
GNU Affero General Public License version 3 (AGPL-3.0)
1113

12-
## 如何貢獻專案 How to contribute?
14+
## 如何貢獻專案
1315

14-
The more details about how to contribute, please learn more
15-
from [Volunteer Docs](https://volunteer.coscup.org/docs/).
16+
更多的如何貢獻細節可以參考「[志工平台文件](https://volunteer.coscup.org/docs/)」。
1617

1718
### Fork me
1819

1920
1. 使用 [github fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) 的方式建立一份到自己的帳號底下。(詳細的操作可以參考 [Working with forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks)
2021
2. 參考 `README.md``Local Development` 先建立起本地端開發環境。
2122

22-
### Create a Pull Request(PR)
23+
### Pull Request(PR)
2324

24-
如果你的開發很順利,覺得可以送出一版 PR 讓我們 review,也請透過 Github [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) 的方式發給我們!
25+
如果你的開發很順利,覺得可以送出一版 PR 讓我們 review,也請透過 Github 建立 [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) 的方式發給我們!
2526

26-
### More Details
27+
### 更多相關資訊
2728

2829
1. 請先閱讀開發文件中的 [Introduction](https://volunteer.coscup.org/docs/intro/),了解平台的架構與服務。
2930
2. 查看目前已知的問題 [Issues](https://github.com/COSCUP/COSCUP-Volunteer/issues)
@@ -32,11 +33,57 @@ from [Volunteer Docs](https://volunteer.coscup.org/docs/).
3233

3334
更詳細的開發內容可以參考[開發文件](https://volunteer.coscup.org/docs/)
3435

35-
## Issues
36+
## 問題回報
3637

3738
問題回報請使用 Issues、如果遇到安全問題的回報,可以使用 GPG 加密後回報。
3839

3940
- COSCUP Volunteer ([email protected])
4041
[8532 8B3E 5669 83C4 F4FD 0487 6842 9A6C D968 9A13](https://volunteer.coscup.org/pgp/85328B3E566983C4F4FD048768429A6CD9689A13.asc)
4142
- Toomore Chiang ([email protected])
4243
[DD5B 53B5 ECC3 0E9F 6B4F 4E47 B55D DBA4 944B 6241](https://volunteer.coscup.org/pgp/DD5B53B5ECC30E9F6B4F4E47B55DDBA4944B6241.asc)
44+
45+
46+
---
47+
48+
# COSCUP Volunteer
49+
50+
![GitHub](https://img.shields.io/github/license/COSCUP/COSCUP-Volunteer) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6869/badge)](https://bestpractices.coreinfrastructure.org/projects/6869)
51+
52+
The COSCUP volunteer platform is an online tool that allows interested individuals to register as volunteers for the conference, and a way for volunteers to communicate with each other and with the organizers.
53+
54+
## License
55+
56+
GNU Affero General Public License version 3 (AGPL-3.0)
57+
58+
## How to contribute?
59+
60+
The more details about how to contribute, please learn more
61+
from [Volunteer Docs](https://volunteer.coscup.org/docs/).
62+
63+
## Fork me
64+
65+
1. Create a fork on your own GitHub account using the '[fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo)' feature. (For detailed instructions, please refer to '[Working with forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks)' guide.)
66+
2. Refer to the "Local Development" section in the README.md to set up the local development environment first.
67+
68+
## Pull Request(PR)
69+
70+
If your development is smooth and you feel ready to submit a version for review, please use the Github pull request feature to send it to us!
71+
72+
## More details
73+
74+
1. Please read the Introduction in the development documentation
75+
to understand the platform's architecture and services.
76+
2. Check the known issues in Issues.
77+
3. Check the current development roadmap.
78+
4. Or, discuss in the `COSCUP Secretary Team - Development` channel.
79+
80+
More detailed development information can be found in the [development documentation](https://volunteer.coscup.org/docs/).
81+
82+
## Report
83+
84+
Please use "Issues" to report any problems. If you encounter security issues, please report them encrypted using GPG.
85+
86+
- COSCUP Volunteer ([email protected])
87+
[8532 8B3E 5669 83C4 F4FD 0487 6842 9A6C D968 9A13](https://volunteer.coscup.org/pgp/85328B3E566983C4F4FD048768429A6CD9689A13.asc)
88+
- Toomore Chiang ([email protected])
89+
[DD5B 53B5 ECC3 0E9F 6B4F 4E47 B55D DBA4 944B 6241](https://volunteer.coscup.org/pgp/DD5B53B5ECC30E9F6B4F4E47B55DDBA4944B6241.asc)

0 commit comments

Comments
 (0)