瀏覽代碼

doc: add information about how to contribute

Inspired by the document at jitsi/jitsi.
j8
Saúl Ibarra Corretgé 8 年之前
父節點
當前提交
92f58cb3c1
共有 2 個檔案被更改,包括 38 行新增0 行删除
  1. 33
    0
      CONTRIBUTING.md
  2. 5
    0
      README.md

+ 33
- 0
CONTRIBUTING.md 查看文件

1
+# How to contribute
2
+We would love to have your help. Before you start working however, please read
3
+and follow this short guide.
4
+
5
+# Reporting Issues
6
+Before you open an issue on GitHub, please discuss it on one of our
7
+[mailing lists](https://jitsi.org/Development/MailingLists) and wait for
8
+confirmation from one of the committers. Once you have that confirmation,
9
+please proceed to reporting the issue on GitHub, while providing as much
10
+information as possible. Mention the version of Jitsi Meet, Jicofo and JVB
11
+you are using, and explain (as detailed as you can) how the problem can
12
+be reproduced.
13
+
14
+# Code contributions
15
+Found a bug and know how to fix it? Great! Please read on.
16
+
17
+## Contributor License Agreement
18
+While the Jitsi projects are released under the
19
+[Apache License 2.0](https://github.com/jitsi/jitsi-meet/blob/master/LICENSE), the copyright
20
+holder and principal creator is [Atlassian](https://www.atlassian.com/). To
21
+ensure that we can continue making these projects available under an Open Source license,
22
+we need you to sign our Apache-based contributor
23
+license agreement as either a [corporation](https://jitsi.org/ccla) or an
24
+[individual](https://jitsi.org/icla). If you cannot accept the terms laid out
25
+in the agreement, unfortunately, we cannot accept your contribution.
26
+
27
+## Creating Pull Requests
28
+- Make sure your code passes the linter rules beforehand. The linter is exeuted
29
+  automatically when committing code.
30
+- Perform **one** logical change per pull request.
31
+- Maintain a clean list of commits, squash them if necessary.
32
+- Rebase your topic branch on top of the master branch before creating the pull
33
+ request.

+ 5
- 0
README.md 查看文件

86
 npm install
86
 npm install
87
 ```
87
 ```
88
 
88
 
89
+## Contributing
90
+
91
+If you are looking to contribute to Jitsi Meet, first of all, thank you! Please
92
+see our [guidelines for contributing](CONTRIBUTING.md).
93
+
89
 ## Embedding in external applications
94
 ## Embedding in external applications
90
 
95
 
91
 Jitsi Meet provides a very flexible way of embedding it in external applications by using the [Jitsi Meet API](doc/api.md).
96
 Jitsi Meet provides a very flexible way of embedding it in external applications by using the [Jitsi Meet API](doc/api.md).

Loading…
取消
儲存