Skip to content

Commit 9d87894

Browse files
threema-danilodbrgn
authored andcommitted
Add CONTRIBUTING.md
1 parent 6fc1d3c commit 9d87894

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

Diff for: CONTRIBUTING.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing to Threema Web
2+
3+
Contributions to Threema Web are welcome! Please follow these steps:
4+
5+
## 1. Claim an Issue
6+
7+
To avoid having multiple people working on the same problem, make sure that an
8+
issue exists for it. If one already exists, add a comment that you would like
9+
to work on that problem. If you have questions, let us know, we'll try to help
10+
you with the implementation.
11+
12+
## 2. Code
13+
14+
Do the necessary changes. After you're done, please run our tests and linting
15+
checks:
16+
17+
npm run build
18+
chromium tests/testsuite.html
19+
npm run lint
20+
21+
If no errors appear, you're good to go.
22+
23+
## 3. Create a Pull Request
24+
25+
Please create a Github pull request against [our
26+
Repository](https://github.com/threema-ch/threema-web). Make sure to reference
27+
the issue in the description.
28+
29+
## 4. Sign the CLA
30+
31+
We require all contributors to sign a CLA. You can find it here:
32+
33+
https://cla-assistant.io/threema-ch/threema-web
34+
35+
Please sign the CLA with your Github account so that we can accept your
36+
pull request.

0 commit comments

Comments
 (0)