mirror of
https://github.com/element-hq/synapse
synced 2024-08-19 03:20:52 +00:00
deploy: 798a507ee0
This commit is contained in:
parent
7a029202fa
commit
5bc63a2d9c
4 changed files with 32 additions and 140 deletions
|
@ -162,15 +162,15 @@
|
|||
<h1 id="contributing"><a class="header" href="#contributing">Contributing</a></h1>
|
||||
<p>This document aims to get you started with contributing to Synapse!</p>
|
||||
<h1 id="1-who-can-contribute-to-synapse"><a class="header" href="#1-who-can-contribute-to-synapse">1. Who can contribute to Synapse?</a></h1>
|
||||
<p>Everyone is welcome to contribute code to <a href="https://github.com/element-hq/synapse">Synapse</a>,
|
||||
provided that they are willing to
|
||||
license their contributions under the same license as the project itself. We
|
||||
follow a simple 'inbound=outbound' model for contributions: the act of
|
||||
submitting an 'inbound' contribution means that the contributor agrees to
|
||||
license the code under the same terms as the project's overall 'outbound'
|
||||
license - in our case, this is almost always Apache Software License v2 (see
|
||||
<a href="https://github.com/element-hq/synapse/blob/develop/LICENSE">LICENSE</a>).</p>
|
||||
<p>TODO THIS NEEDS UPDATING</p>
|
||||
<p>Everyone is welcome to contribute code to
|
||||
<a href="https://github.com/element-hq/synapse">Synapse</a>, provided that they are willing
|
||||
to license their contributions to Element under a <a href="https://cla-assistant.io/element-hq/synapse">Contributor License
|
||||
Agreement</a> (CLA). This ensures that
|
||||
their contribution will be made available under an OSI-approved open-source
|
||||
license, currently Affero General Public License v3 (AGPLv3).</p>
|
||||
<p>Please see the
|
||||
<a href="https://element.io/blog/synapse-now-lives-at-github-com-element-hq-synapse/">Element blog post</a>
|
||||
for the full rationale.</p>
|
||||
<h1 id="2-what-do-i-need"><a class="header" href="#2-what-do-i-need">2. What do I need?</a></h1>
|
||||
<p>If you are running Windows, the Windows Subsystem for Linux (WSL) is strongly
|
||||
recommended for development. More information about WSL can be found at
|
||||
|
@ -505,70 +505,16 @@ directory, you will need both a regular newsfragment <em>and</em> an entry in th
|
|||
debian changelog. (Though typically such changes should be submitted as two
|
||||
separate pull requests.)</p>
|
||||
<h2 id="sign-off"><a class="header" href="#sign-off">Sign off</a></h2>
|
||||
<p>In order to have a concrete record that your contribution is intentional
|
||||
and you agree to license it under the same terms as the project's license, we've adopted the
|
||||
same lightweight approach that the Linux Kernel
|
||||
<a href="https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin%3E">submitting patches process</a>,
|
||||
<a href="https://github.com/docker/docker/blob/master/CONTRIBUTING.md">Docker</a>, and many other
|
||||
projects use: the DCO (<a href="http://developercertificate.org/">Developer Certificate of Origin</a>).
|
||||
This is a simple declaration that you wrote
|
||||
the contribution or otherwise have the right to contribute it to Matrix:</p>
|
||||
<pre><code>Developer Certificate of Origin
|
||||
Version 1.1
|
||||
|
||||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
||||
660 York Street, Suite 102,
|
||||
San Francisco, CA 94110 USA
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this
|
||||
license document, but changing it is not allowed.
|
||||
|
||||
Developer's Certificate of Origin 1.1
|
||||
|
||||
By making a contribution to this project, I certify that:
|
||||
|
||||
(a) The contribution was created in whole or in part by me and I
|
||||
have the right to submit it under the open source license
|
||||
indicated in the file; or
|
||||
|
||||
(b) The contribution is based upon previous work that, to the best
|
||||
of my knowledge, is covered under an appropriate open source
|
||||
license and I have the right under that license to submit that
|
||||
work with modifications, whether created in whole or in part
|
||||
by me, under the same open source license (unless I am
|
||||
permitted to submit under a different license), as indicated
|
||||
in the file; or
|
||||
|
||||
(c) The contribution was provided directly to me by some other
|
||||
person who certified (a), (b) or (c) and I have not modified
|
||||
it.
|
||||
|
||||
(d) I understand and agree that this project and the contribution
|
||||
are public and that a record of the contribution (including all
|
||||
personal information I submit with it, including my sign-off) is
|
||||
maintained indefinitely and may be redistributed consistent with
|
||||
this project or the open source license(s) involved.
|
||||
</code></pre>
|
||||
<p>If you agree to this for your contribution, then all that's needed is to
|
||||
include the line in your commit or pull request comment:</p>
|
||||
<pre><code>Signed-off-by: Your Name <your@email.example.org>
|
||||
</code></pre>
|
||||
<p>After you make a PR a comment from @CLAassistant will appear asking you to sign
|
||||
the <a href="https://cla-assistant.io/element-hq/synapse">CLA</a>.
|
||||
This will link a page to allow you to confirm that you have read and agreed to
|
||||
the CLA by signing in with GitHub.</p>
|
||||
<p>Alternatively, you can sign off before opening a PR by going to
|
||||
<a href="https://cla-assistant.io/element-hq/synapse">https://cla-assistant.io/element-hq/synapse</a>.</p>
|
||||
<p>We accept contributions under a legally identifiable name, such as
|
||||
your name on government documentation or common-law names (names
|
||||
claimed by legitimate usage or repute). Unfortunately, we cannot
|
||||
accept anonymous contributions at this time.</p>
|
||||
<p>Git allows you to add this signoff automatically when using the <code>-s</code>
|
||||
flag to <code>git commit</code>, which uses the name and email set in your
|
||||
<code>user.name</code> and <code>user.email</code> git configs.</p>
|
||||
<h3 id="private-sign-off"><a class="header" href="#private-sign-off">Private Sign off</a></h3>
|
||||
<p>If you would like to provide your legal name privately to the Matrix.org
|
||||
Foundation (instead of in a public commit or comment), you can do so
|
||||
by emailing your legal name and a link to the pull request to
|
||||
<a href="mailto:dco@matrix.org?subject=Private%20sign%20off">dco@matrix.org</a>.
|
||||
It helps to include "sign off" or similar in the subject line. You will then
|
||||
be instructed further.</p>
|
||||
<p>Once private sign off is complete, doing so for future contributions will not
|
||||
be required.</p>
|
||||
<h1 id="10-turn-feedback-into-better-code"><a class="header" href="#10-turn-feedback-into-better-code">10. Turn feedback into better code.</a></h1>
|
||||
<p>Once the Pull Request is opened, you will see a few things:</p>
|
||||
<ol>
|
||||
|
|
|
@ -16428,15 +16428,15 @@ you see this failure mode so we can help debug it, however.</p>
|
|||
<div style="break-before: page; page-break-before: always;"></div><h1 id="contributing"><a class="header" href="#contributing">Contributing</a></h1>
|
||||
<p>This document aims to get you started with contributing to Synapse!</p>
|
||||
<h1 id="1-who-can-contribute-to-synapse"><a class="header" href="#1-who-can-contribute-to-synapse">1. Who can contribute to Synapse?</a></h1>
|
||||
<p>Everyone is welcome to contribute code to <a href="https://github.com/element-hq/synapse">Synapse</a>,
|
||||
provided that they are willing to
|
||||
license their contributions under the same license as the project itself. We
|
||||
follow a simple 'inbound=outbound' model for contributions: the act of
|
||||
submitting an 'inbound' contribution means that the contributor agrees to
|
||||
license the code under the same terms as the project's overall 'outbound'
|
||||
license - in our case, this is almost always Apache Software License v2 (see
|
||||
<a href="https://github.com/element-hq/synapse/blob/develop/LICENSE">LICENSE</a>).</p>
|
||||
<p>TODO THIS NEEDS UPDATING</p>
|
||||
<p>Everyone is welcome to contribute code to
|
||||
<a href="https://github.com/element-hq/synapse">Synapse</a>, provided that they are willing
|
||||
to license their contributions to Element under a <a href="https://cla-assistant.io/element-hq/synapse">Contributor License
|
||||
Agreement</a> (CLA). This ensures that
|
||||
their contribution will be made available under an OSI-approved open-source
|
||||
license, currently Affero General Public License v3 (AGPLv3).</p>
|
||||
<p>Please see the
|
||||
<a href="https://element.io/blog/synapse-now-lives-at-github-com-element-hq-synapse/">Element blog post</a>
|
||||
for the full rationale.</p>
|
||||
<h1 id="2-what-do-i-need"><a class="header" href="#2-what-do-i-need">2. What do I need?</a></h1>
|
||||
<p>If you are running Windows, the Windows Subsystem for Linux (WSL) is strongly
|
||||
recommended for development. More information about WSL can be found at
|
||||
|
@ -16771,70 +16771,16 @@ directory, you will need both a regular newsfragment <em>and</em> an entry in th
|
|||
debian changelog. (Though typically such changes should be submitted as two
|
||||
separate pull requests.)</p>
|
||||
<h2 id="sign-off"><a class="header" href="#sign-off">Sign off</a></h2>
|
||||
<p>In order to have a concrete record that your contribution is intentional
|
||||
and you agree to license it under the same terms as the project's license, we've adopted the
|
||||
same lightweight approach that the Linux Kernel
|
||||
<a href="https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin%3E">submitting patches process</a>,
|
||||
<a href="https://github.com/docker/docker/blob/master/CONTRIBUTING.md">Docker</a>, and many other
|
||||
projects use: the DCO (<a href="http://developercertificate.org/">Developer Certificate of Origin</a>).
|
||||
This is a simple declaration that you wrote
|
||||
the contribution or otherwise have the right to contribute it to Matrix:</p>
|
||||
<pre><code>Developer Certificate of Origin
|
||||
Version 1.1
|
||||
|
||||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
||||
660 York Street, Suite 102,
|
||||
San Francisco, CA 94110 USA
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this
|
||||
license document, but changing it is not allowed.
|
||||
|
||||
Developer's Certificate of Origin 1.1
|
||||
|
||||
By making a contribution to this project, I certify that:
|
||||
|
||||
(a) The contribution was created in whole or in part by me and I
|
||||
have the right to submit it under the open source license
|
||||
indicated in the file; or
|
||||
|
||||
(b) The contribution is based upon previous work that, to the best
|
||||
of my knowledge, is covered under an appropriate open source
|
||||
license and I have the right under that license to submit that
|
||||
work with modifications, whether created in whole or in part
|
||||
by me, under the same open source license (unless I am
|
||||
permitted to submit under a different license), as indicated
|
||||
in the file; or
|
||||
|
||||
(c) The contribution was provided directly to me by some other
|
||||
person who certified (a), (b) or (c) and I have not modified
|
||||
it.
|
||||
|
||||
(d) I understand and agree that this project and the contribution
|
||||
are public and that a record of the contribution (including all
|
||||
personal information I submit with it, including my sign-off) is
|
||||
maintained indefinitely and may be redistributed consistent with
|
||||
this project or the open source license(s) involved.
|
||||
</code></pre>
|
||||
<p>If you agree to this for your contribution, then all that's needed is to
|
||||
include the line in your commit or pull request comment:</p>
|
||||
<pre><code>Signed-off-by: Your Name <your@email.example.org>
|
||||
</code></pre>
|
||||
<p>After you make a PR a comment from @CLAassistant will appear asking you to sign
|
||||
the <a href="https://cla-assistant.io/element-hq/synapse">CLA</a>.
|
||||
This will link a page to allow you to confirm that you have read and agreed to
|
||||
the CLA by signing in with GitHub.</p>
|
||||
<p>Alternatively, you can sign off before opening a PR by going to
|
||||
<a href="https://cla-assistant.io/element-hq/synapse">https://cla-assistant.io/element-hq/synapse</a>.</p>
|
||||
<p>We accept contributions under a legally identifiable name, such as
|
||||
your name on government documentation or common-law names (names
|
||||
claimed by legitimate usage or repute). Unfortunately, we cannot
|
||||
accept anonymous contributions at this time.</p>
|
||||
<p>Git allows you to add this signoff automatically when using the <code>-s</code>
|
||||
flag to <code>git commit</code>, which uses the name and email set in your
|
||||
<code>user.name</code> and <code>user.email</code> git configs.</p>
|
||||
<h3 id="private-sign-off"><a class="header" href="#private-sign-off">Private Sign off</a></h3>
|
||||
<p>If you would like to provide your legal name privately to the Matrix.org
|
||||
Foundation (instead of in a public commit or comment), you can do so
|
||||
by emailing your legal name and a link to the pull request to
|
||||
<a href="mailto:dco@matrix.org?subject=Private%20sign%20off">dco@matrix.org</a>.
|
||||
It helps to include "sign off" or similar in the subject line. You will then
|
||||
be instructed further.</p>
|
||||
<p>Once private sign off is complete, doing so for future contributions will not
|
||||
be required.</p>
|
||||
<h1 id="10-turn-feedback-into-better-code"><a class="header" href="#10-turn-feedback-into-better-code">10. Turn feedback into better code.</a></h1>
|
||||
<p>Once the Pull Request is opened, you will see a few things:</p>
|
||||
<ol>
|
||||
|
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue