CONTRIBUTING.rst 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  1. Contributing code to Matrix
  2. ===========================
  3. Everyone is welcome to contribute code to Matrix
  4. (https://github.com/matrix-org), provided that they are willing to license
  5. their contributions under the same license as the project itself. We follow a
  6. simple 'inbound=outbound' model for contributions: the act of submitting an
  7. 'inbound' contribution means that the contributor agrees to license the code
  8. under the same terms as the project's overall 'outbound' license - in our
  9. case, this is almost always Apache Software License v2 (see LICENSE).
  10. How to contribute
  11. ~~~~~~~~~~~~~~~~~
  12. The preferred and easiest way to contribute changes to Matrix is to fork the
  13. relevant project on github, and then create a pull request to ask us to pull
  14. your changes into our repo
  15. (https://help.github.com/articles/using-pull-requests/)
  16. **The single biggest thing you need to know is: please base your changes on
  17. the develop branch - /not/ master.**
  18. We use the master branch to track the most recent release, so that folks who
  19. blindly clone the repo and automatically check out master get something that
  20. works. Develop is the unstable branch where all the development actually
  21. happens: the workflow is that contributors should fork the develop branch to
  22. make a 'feature' branch for a particular contribution, and then make a pull
  23. request to merge this back into the matrix.org 'official' develop branch. We
  24. use github's pull request workflow to review the contribution, and either ask
  25. you to make any refinements needed or merge it and make them ourselves. The
  26. changes will then land on master when we next do a release.
  27. We use `CircleCI <https://circleci.com/gh/matrix-org>`_ and `Travis CI
  28. <https://travis-ci.org/matrix-org/synapse>`_ for continuous integration. All
  29. pull requests to synapse get automatically tested by Travis and CircleCI.
  30. If your change breaks the build, this will be shown in GitHub, so please
  31. keep an eye on the pull request for feedback.
  32. To run unit tests in a local development environment, you can use:
  33. - ``tox -e py27`` (requires tox to be installed by ``pip install tox``) for
  34. SQLite-backed Synapse on Python 2.7.
  35. - ``tox -e py35`` for SQLite-backed Synapse on Python 3.5.
  36. - ``tox -e py36`` for SQLite-backed Synapse on Python 3.6.
  37. - ``tox -e py27-postgres`` for PostgreSQL-backed Synapse on Python 2.7
  38. (requires a running local PostgreSQL with access to create databases).
  39. - ``./test_postgresql.sh`` for PostgreSQL-backed Synapse on Python 2.7
  40. (requires Docker). Entirely self-contained, recommended if you don't want to
  41. set up PostgreSQL yourself.
  42. Docker images are available for running the integration tests (SyTest) locally,
  43. see the `documentation in the SyTest repo
  44. <https://github.com/matrix-org/sytest/blob/develop/docker/README.md>`_ for more
  45. information.
  46. Code style
  47. ~~~~~~~~~~
  48. All Matrix projects have a well-defined code-style - and sometimes we've even
  49. got as far as documenting it... For instance, synapse's code style doc lives
  50. at https://github.com/matrix-org/synapse/tree/master/docs/code_style.rst.
  51. Please ensure your changes match the cosmetic style of the existing project,
  52. and **never** mix cosmetic and functional changes in the same commit, as it
  53. makes it horribly hard to review otherwise.
  54. Changelog
  55. ~~~~~~~~~
  56. All changes, even minor ones, need a corresponding changelog / newsfragment
  57. entry. These are managed by Towncrier
  58. (https://github.com/hawkowl/towncrier).
  59. To create a changelog entry, make a new file in the ``changelog.d``
  60. file named in the format of ``PRnumber.type``. The type can be
  61. one of ``feature``, ``bugfix``, ``removal`` (also used for
  62. deprecations), or ``misc`` (for internal-only changes). The content of
  63. the file is your changelog entry, which can contain Markdown
  64. formatting. Adding credits to the changelog is encouraged, we value
  65. your contributions and would like to have you shouted out in the
  66. release notes!
  67. For example, a fix in PR #1234 would have its changelog entry in
  68. ``changelog.d/1234.bugfix``, and contain content like "The security levels of
  69. Florbs are now validated when recieved over federation. Contributed by Jane
  70. Matrix".
  71. Attribution
  72. ~~~~~~~~~~~
  73. Everyone who contributes anything to Matrix is welcome to be listed in the
  74. AUTHORS.rst file for the project in question. Please feel free to include a
  75. change to AUTHORS.rst in your pull request to list yourself and a short
  76. description of the area(s) you've worked on. Also, we sometimes have swag to
  77. give away to contributors - if you feel that Matrix-branded apparel is missing
  78. from your life, please mail us your shipping address to matrix at matrix.org and
  79. we'll try to fix it :)
  80. Sign off
  81. ~~~~~~~~
  82. In order to have a concrete record that your contribution is intentional
  83. and you agree to license it under the same terms as the project's license, we've adopted the
  84. same lightweight approach that the Linux Kernel
  85. (https://www.kernel.org/doc/Documentation/SubmittingPatches), Docker
  86. (https://github.com/docker/docker/blob/master/CONTRIBUTING.md), and many other
  87. projects use: the DCO (Developer Certificate of Origin:
  88. http://developercertificate.org/). This is a simple declaration that you wrote
  89. the contribution or otherwise have the right to contribute it to Matrix::
  90. Developer Certificate of Origin
  91. Version 1.1
  92. Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
  93. 660 York Street, Suite 102,
  94. San Francisco, CA 94110 USA
  95. Everyone is permitted to copy and distribute verbatim copies of this
  96. license document, but changing it is not allowed.
  97. Developer's Certificate of Origin 1.1
  98. By making a contribution to this project, I certify that:
  99. (a) The contribution was created in whole or in part by me and I
  100. have the right to submit it under the open source license
  101. indicated in the file; or
  102. (b) The contribution is based upon previous work that, to the best
  103. of my knowledge, is covered under an appropriate open source
  104. license and I have the right under that license to submit that
  105. work with modifications, whether created in whole or in part
  106. by me, under the same open source license (unless I am
  107. permitted to submit under a different license), as indicated
  108. in the file; or
  109. (c) The contribution was provided directly to me by some other
  110. person who certified (a), (b) or (c) and I have not modified
  111. it.
  112. (d) I understand and agree that this project and the contribution
  113. are public and that a record of the contribution (including all
  114. personal information I submit with it, including my sign-off) is
  115. maintained indefinitely and may be redistributed consistent with
  116. this project or the open source license(s) involved.
  117. If you agree to this for your contribution, then all that's needed is to
  118. include the line in your commit or pull request comment::
  119. Signed-off-by: Your Name <your@email.example.org>
  120. We accept contributions under a legally identifiable name, such as
  121. your name on government documentation or common-law names (names
  122. claimed by legitimate usage or repute). Unfortunately, we cannot
  123. accept anonymous contributions at this time.
  124. Git allows you to add this signoff automatically when using the ``-s``
  125. flag to ``git commit``, which uses the name and email set in your
  126. ``user.name`` and ``user.email`` git configs.
  127. Conclusion
  128. ~~~~~~~~~~
  129. That's it! Matrix is a very open and collaborative project as you might expect
  130. given our obsession with open communication. If we're going to successfully
  131. matrix together all the fragmented communication technologies out there we are
  132. reliant on contributions and collaboration from the community to do so. So
  133. please get involved - and we hope you have as much fun hacking on Matrix as we
  134. do!