1- Contributing code to matrix-widget-api
2- ======================================
1+ # Contributing code to matrix-widget-api
32
43Everyone is welcome to contribute code to matrix-widget-api, provided that they are
54willing to license their contributions under the same license as the project
65itself. We follow a simple 'inbound=outbound' model for contributions: the act
76of submitting an 'inbound' contribution means that the contributor agrees to
87license the code under the same terms as the project's overall 'outbound'
9- license - in this case, Apache Software License v2 (see `< LICENSE >`_ ).
8+ license - in this case, Apache Software License v2 (see [ LICENSE] ( ./LICENSE ) ).
109
11- How to contribute
12- ~~~~~~~~~~~~~~~~~
10+ ## How to contribute
1311
1412The preferred and easiest way to contribute changes to the project is to fork
1513it on github, and then create a pull request to ask us to pull your changes
1614into our repo (https://help.github.com/articles/using-pull-requests/ )
1715
18- **The single biggest thing you need to know is: please base your changes on
19- the develop branch - /not/ master. **
20-
2116We use the master branch to track the most recent release, so that folks who
2217blindly clone the repo and automatically check out master get something that
2318works. Develop is the unstable branch where all the development actually
@@ -32,8 +27,7 @@ We use continuous integration, and all pull requests get automatically tested
3227by it: if your change breaks the build, then the PR will show that there are
3328failed checks, so please check back after a few minutes.
3429
35- Code style
36- ~~~~~~~~~~
30+ ## Code style
3731
3832This project aims to target TypeScript with published versions having JS-compatible
3933code. All files should be written in TypeScript.
@@ -44,16 +38,15 @@ introduce naming problems (as default exports get aliased upon import). In
4438general, avoid using ` export default ` .
4539
4640The remaining code-style for matrix-widget-api is not formally documented, but
47- contributors are encouraged to read the code style document for matrix-react-sdk
48- (`< https://github.com/matrix-org/matrix-react-sdk/blob/master/code_style.md >`_ )
41+ contributors are encouraged to read the
42+ [ code style document for matrix-react-sdk ] ( https://github.com/matrix-org/matrix-react-sdk/blob/master/code_style.md )
4943and follow the principles set out there.
5044
5145Please ensure your changes match the cosmetic style of the existing project,
5246and ** never** mix cosmetic and functional changes in the same commit, as it
5347makes it horribly hard to review otherwise.
5448
55- Sign off
56- ~~~~~~~~
49+ ## Sign off
5750
5851In order to have a concrete record that your contribution is intentional
5952and you agree to license it under the same terms as the project's license, we've
@@ -62,8 +55,9 @@ adopted the same lightweight approach that the Linux Kernel
6255(https://github.com/docker/docker/blob/master/CONTRIBUTING.md ), and many other
6356projects use: the DCO (Developer Certificate of Origin:
6457http://developercertificate.org/ ). This is a simple declaration that you wrote
65- the contribution or otherwise have the right to contribute it to Matrix::
58+ the contribution or otherwise have the right to contribute it to Matrix:
6659
60+ ```
6761 Developer Certificate of Origin
6862 Version 1.1
6963
@@ -99,22 +93,27 @@ the contribution or otherwise have the right to contribute it to Matrix::
9993 personal information I submit with it, including my sign-off) is
10094 maintained indefinitely and may be redistributed consistent with
10195 this project or the open source license(s) involved.
96+ ```
10297
10398If you agree to this for your contribution, then all that's needed is to
104- include the line in your commit or pull request comment::
99+ include the line in your commit or pull request comment:
105100
106- Signed-off-by: Your Name <[email protected] > 101+ ```
102+ Signed-off-by: Your Name <[email protected] > 103+ ```
107104
108105We accept contributions under a legally identifiable name, such as your name on
109106government documentation or common-law names (names claimed by legitimate usage
110107or repute). Unfortunately, we cannot accept anonymous contributions at this
111108time.
112109
113- Git allows you to add this signoff automatically when using the `` -s ` ` flag to
114- `` git commit `` , which uses the name and email set in your `` user.name ` ` and
115- `` user.email ` ` git configs.
110+ Git allows you to add this signoff automatically when using the ` -s ` flag to
111+ ` git commit ` , which uses the name and email set in your ` user.name ` and
112+ ` user.email ` git configs.
116113
117114If you forgot to sign off your commits before making your pull request and are
118- on Git 2.17+ you can mass signoff using rebase::
115+ on Git 2.17+ you can mass signoff using rebase:
119116
120- git rebase --signoff origin/develop
117+ ```
118+ git rebase --signoff origin/develop
119+ ```
0 commit comments