@@ -4,16 +4,16 @@ This document aims to get you started with contributing to Synapse!
4
4
5
5
# 1. Who can contribute to Synapse?
6
6
7
- Everyone is welcome to contribute code to [ Synapse] ( https://github.com/element-hq/synapse ) ,
8
- provided that they are willing to
9
- license their contributions under the same license as the project itself. We
10
- follow a simple 'inbound=outbound' model for contributions: the act of
11
- submitting an 'inbound' contribution means that the contributor agrees to
12
- license the code under the same terms as the project's overall 'outbound'
13
- license - in our case, this is almost always Apache Software License v2 (see
14
- [ LICENSE] ( https://github.com/element-hq/synapse/blob/develop/LICENSE ) ).
7
+ Everyone is welcome to contribute code to
8
+ [ Synapse] ( https://github.com/element-hq/synapse ) , provided that they are willing
9
+ to license their contributions to Element under a [ Contributor License
10
+ Agreement] ( https://cla-assistant.io/element-hq/synapse ) (CLA). This ensures that
11
+ their contribution will be made available under an OSI-approved open-source
12
+ license, currently Affero General Public License v3 (AGPLv3).
15
13
16
- TODO THIS NEEDS UPDATING
14
+ Please see the
15
+ [ Element blog post] ( https://element.io/blog/synapse-now-lives-at-github-com-element-hq-synapse/ )
16
+ for the full rationale.
17
17
18
18
# 2. What do I need?
19
19
@@ -499,81 +499,19 @@ separate pull requests.)
499
499
500
500
# # Sign off
501
501
502
- In order to have a concrete record that your contribution is intentional
503
- and you agree to license it under the same terms as the project' s license, we' ve adopted the
504
- same lightweight approach that the Linux Kernel
505
- [submitting patches process](
506
- https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin> ),
507
- [Docker](https://github.com/docker/docker/blob/master/CONTRIBUTING.md), and many other
508
- projects use: the DCO ([Developer Certificate of Origin](http://developercertificate.org/)).
509
- This is a simple declaration that you wrote
510
- the contribution or otherwise have the right to contribute it to Matrix:
502
+ After you make a PR a comment from @CLAassistant will appear asking you to sign
503
+ the [CLA](https://cla-assistant.io/element-hq/synapse).
504
+ This will link a page to allow you to confirm that you have read and agreed to
505
+ the CLA by signing in with GitHub.
511
506
512
- ` ` `
513
- Developer Certificate of Origin
514
- Version 1.1
515
-
516
- Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
517
- 660 York Street, Suite 102,
518
- San Francisco, CA 94110 USA
519
-
520
- Everyone is permitted to copy and distribute verbatim copies of this
521
- license document, but changing it is not allowed.
522
-
523
- Developer' s Certificate of Origin 1.1
524
-
525
- By making a contribution to this project, I certify that:
526
-
527
- (a) The contribution was created in whole or in part by me and I
528
- have the right to submit it under the open source license
529
- indicated in the file; or
530
-
531
- (b) The contribution is based upon previous work that, to the best
532
- of my knowledge, is covered under an appropriate open source
533
- license and I have the right under that license to submit that
534
- work with modifications, whether created in whole or in part
535
- by me, under the same open source license (unless I am
536
- permitted to submit under a different license), as indicated
537
- in the file; or
538
-
539
- (c) The contribution was provided directly to me by some other
540
- person who certified (a), (b) or (c) and I have not modified
541
- it.
542
-
543
- (d) I understand and agree that this project and the contribution
544
- are public and that a record of the contribution (including all
545
- personal information I submit with it, including my sign-off) is
546
- maintained indefinitely and may be redistributed consistent with
547
- this project or the open source license(s) involved.
548
- ```
549
-
550
- If you agree to this for your contribution, then all that' s needed is to
551
- include the line in your commit or pull request comment:
552
-
553
- ` ` `
554
- Signed-off-by: Your Name
< [email protected] >
555
- ` ` `
507
+ Alternatively, you can sign off before opening a PR by going to
508
+ < https://cla-assistant.io/element-hq/synapse> .
556
509
557
510
We accept contributions under a legally identifiable name, such as
558
511
your name on government documentation or common-law names (names
559
512
claimed by legitimate usage or repute). Unfortunately, we cannot
560
513
accept anonymous contributions at this time.
561
514
562
- Git allows you to add this signoff automatically when using the ` -s`
563
- flag to ` git commit` , which uses the name and email set in your
564
- ` user.name` and ` user.email` git configs.
565
-
566
- # ## Private Sign off
567
-
568
- If you would like to provide your legal name privately to the Matrix.org
569
- Foundation (instead of in a public commit or comment), you can do so
570
- by emailing your legal name and a link to the pull request to
571
- [[email protected] ](mailto:[email protected] ? subject=Private%20sign%20off).
572
- It helps to include " sign off" or similar in the subject line. You will then
573
- be instructed further.
574
-
575
- Once private sign off is complete, doing so for future contributions will not
576
- be required.
577
515
578
516
# 10. Turn feedback into better code.
579
517
0 commit comments