Skip to content

Commit 8c7e09d

Browse files
authored
Merge pull request #42 from matrix-org/travis/repo-main
Add some github boilerplate
2 parents 5a1293c + b2aa5c2 commit 8c7e09d

File tree

4 files changed

+27
-22
lines changed

4 files changed

+27
-22
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @matrix-org/element-web

.github/FUNDING.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
patreon: matrixdotorg
2+
liberapay: matrixdotorg

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<!-- Please read https://github.com/matrix-org/matrix-widget-api/blob/master/CONTRIBUTING.md before submitting your pull request -->
2+
3+
<!-- Include a Sign-Off as described in https://github.com/matrix-org/matrix-widget-api/blob/master/CONTRIBUTING.md#sign-off -->

CONTRIBUTING.rst renamed to CONTRIBUTING.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
1-
Contributing code to matrix-widget-api
2-
======================================
1+
# Contributing code to matrix-widget-api
32

43
Everyone is welcome to contribute code to matrix-widget-api, provided that they are
54
willing to license their contributions under the same license as the project
65
itself. We follow a simple 'inbound=outbound' model for contributions: the act
76
of submitting an 'inbound' contribution means that the contributor agrees to
87
license 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

1412
The preferred and easiest way to contribute changes to the project is to fork
1513
it on github, and then create a pull request to ask us to pull your changes
1614
into 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-
2116
We use the master branch to track the most recent release, so that folks who
2217
blindly clone the repo and automatically check out master get something that
2318
works. 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
3227
by it: if your change breaks the build, then the PR will show that there are
3328
failed checks, so please check back after a few minutes.
3429

35-
Code style
36-
~~~~~~~~~~
30+
## Code style
3731

3832
This project aims to target TypeScript with published versions having JS-compatible
3933
code. All files should be written in TypeScript.
@@ -44,16 +38,15 @@ introduce naming problems (as default exports get aliased upon import). In
4438
general, avoid using `export default`.
4539

4640
The 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)
4943
and follow the principles set out there.
5044

5145
Please ensure your changes match the cosmetic style of the existing project,
5246
and **never** mix cosmetic and functional changes in the same commit, as it
5347
makes it horribly hard to review otherwise.
5448

55-
Sign off
56-
~~~~~~~~
49+
## Sign off
5750

5851
In order to have a concrete record that your contribution is intentional
5952
and 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
6356
projects use: the DCO (Developer Certificate of Origin:
6457
http://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

10398
If 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

108105
We accept contributions under a legally identifiable name, such as your name on
109106
government documentation or common-law names (names claimed by legitimate usage
110107
or repute). Unfortunately, we cannot accept anonymous contributions at this
111108
time.
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

117114
If 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

Comments
 (0)