1- Contributing to matrix-doc
2- ==========================
1+ Contributing to matrix-spec
2+ ===========================
33
44Everyone is welcome to contribute to the Matrix specification!
55
@@ -9,13 +9,9 @@ Code style
99----------
1010
1111The documentation style is described at
12- https://github.com/matrix-org/matrix-doc /blob/master /meta/documentation_style.rst.
12+ https://github.com/matrix-org/matrix-spec /blob/main /meta/documentation_style.rst.
1313
14- Python code within the ``matrix-doc `` project should follow the same style as
15- synapse, which is documented at
16- https://github.com/matrix-org/synapse/tree/master/docs/code_style.md.
17-
18- Matrix-doc workflows
14+ Matrix-spec workflows
1915--------------------
2016
2117Specification changes
@@ -27,9 +23,7 @@ server before they can be documented in the specification. This process can take
2723some time to complete.
2824
2925Changes to the protocol (new endpoints, ideas, etc) need to go through the
30- `proposals process <https://matrix.org/docs/spec/proposals >`_. Other changes,
31- such as fixing bugs, typos, or clarifying existing behaviour do not need a proposal.
32- If you're not sure, visit us at `#matrix-spec:matrix.org `_ and ask.
26+ `proposals process <https://matrix.org/docs/spec/proposals >`_.
3327
3428Other changes
3529~~~~~~~~~~~~~
@@ -42,20 +36,20 @@ following:
4236
4337* Addition of features which have been in use in practice for some time, but
4438 have never made it into the spec (including anything with the `spec-omission
45- <https://github.com/matrix-org/matrix-doc /labels/spec-omission> `_ label).
39+ <https://github.com/matrix-org/matrix-spec /labels/spec-omission> `_ label).
4640
4741* Likewise, corrections to the specification, to fix situations where, in
4842 practice, servers and clients behave differently to the specification,
4943 including anything with the `spec-bug
50- <https://github.com/matrix-org/matrix-doc /labels/spec-bug> `_ label.
44+ <https://github.com/matrix-org/matrix-spec /labels/spec-bug> `_ label.
5145
5246 (If there is any doubt about whether it is the spec or the implementations
5347 that need fixing, please discuss it with us first in `#matrix-spec:matrix.org `_.)
5448
5549* Clarifications to the specification which do not change the behaviour of
5650 Matrix servers or clients in a way which might introduce compatibility
5751 problems for existing deployments. This includes anything with the
58- `clarification <https://github.com/matrix-org/matrix-doc /labels/clarification >`_
52+ `clarification <https://github.com/matrix-org/matrix-spec /labels/clarification >`_
5953 label.
6054
6155 For example, areas where the specification is unclear do not require a proposal
@@ -81,7 +75,7 @@ Adding to the changelog
8175All API specifications require a changelog entry. Adding to the changelog can only
8276be done after you've opened your pull request, so be sure to do that first.
8377
84- The changelog is managed by Towncrier ( https://github.com/hawkowl /towncrier) in the
78+ The changelog is managed by ` Towncrier < https://github.com/twisted /towncrier >`_ in the
8579form of "news fragments". The news fragments for the client-server API are stored
8680under ``changelogs/client_server/newsfragments ``.
8781
@@ -111,7 +105,7 @@ CSS, etc should not get a news fragment.
111105Sign off
112106--------
113107
114- We ask that everybody who contributes to their project signs off their
108+ We ask that everybody who contributes to this project signs off their
115109contributions, as explained below.
116110
117111We follow a simple 'inbound=outbound' model for contributions: the act of
@@ -121,11 +115,10 @@ license - in our case, this is Apache Software License v2 (see LICENSE).
121115
122116In order to have a concrete record that your contribution is intentional
123117and you agree to license it under the same terms as the project's license, we've adopted the
124- same lightweight approach that the Linux Kernel
125- (https://www.kernel.org/doc/Documentation/SubmittingPatches), Docker
126- (https://github.com/docker/docker/blob/master/CONTRIBUTING.md), and many other
127- projects use: the DCO (Developer Certificate of Origin:
128- http://developercertificate.org/). This is a simple declaration that you wrote
118+ same lightweight approach used by the `Linux Kernel <https://www.kernel.org/doc/html/latest/process/submitting-patches.html >`_,
119+ `Docker <https://github.com/docker/docker/blob/master/CONTRIBUTING.md `_, and many other
120+ projects: the `Developer Certificate of Origin <http://developercertificate.org/ >`_
121+ (DCO). This is a simple declaration that you wrote
129122the contribution or otherwise have the right to contribute it to Matrix::
130123
131124 Developer Certificate of Origin
0 commit comments