summary refs log tree commit diff
path: root/docs/development/contributing_guide.md (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Add an OSX prompt to manually configure icu4c. (#17069)Neil Johnson2024-04-191-0/+2
| | | Documentation fix.
* Remove the hardcoded poetry version from contributing guide (#17002)Tadeusz Sośnierz2024-03-211-1/+1
|
* Fix broken links on docs (#16853)kegsay2024-02-061-1/+1
| | | | Some links seemed to be incorrect (vector-im/sygnal and vector-im/sytest have never been A Thing iirc) so pointed them back to matrix-org/*).
* Fix broken links in issue template (#16810)Erik Johnston2024-01-171-3/+3
| | | This happened during the migration
* Update the contributing guide after reliecensing (#16772)Erik Johnston2024-01-031-77/+15
|
* Update documentation to refer to element-hq.Patrick Cloke2023-12-131-19/+17
|
* Fix poetry version typo in contributors' guide (#16695)David Robertson2023-11-271-1/+1
|
* Pin the recommended poetry version in contributors' guide (#16550)David Robertson2023-10-251-1/+1
|
* Fix-up incorrect spellings in docs. (#16282)Patrick Cloke2023-09-081-1/+1
|
* Unix Sockets for HTTP Replication (#15708)Jason Little2023-07-111-0/+1
| | | | | | | | | Unix socket support for `federation` and `client` Listeners has existed now for a little while(since [1.81.0](https://github.com/matrix-org/synapse/pull/15353)), but there was one last hold out before it could be complete: HTTP Replication communication. This should finish it up. The Listeners would have always worked, but would have had no way to be talked to/at. --------- Co-authored-by: Eric Eastwood <madlittlemods@gmail.com> Co-authored-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> Co-authored-by: Eric Eastwood <erice@element.io>
* Drop debian buster (#15893)Shay2023-07-101-1/+1
|
* Documentation improvements to contributing guide (#15667) (#15668)Grant McLean2023-05-261-5/+28
| | | | | | | | | Fix #15667 - Reiterate the importance of getting Rust installed and set up before attempting to install the Python dependencies. - Mention the importance of confirming that `poetry install` completed successfully and include a typical error that the user might see if it did not. - Expand on "Now edit homeserver.yaml" to give examples of things likely to need changing and to link to the relevant sections of the Synapse server documentation.
* Allow running Complement integration tests via podman (#15543)Andrew Morgan2023-05-051-0/+1
|
* Document how to run Synapse (#15022)Andy Balaam2023-02-081-0/+13
| | | | | | | | * Document how to run Synapse * Changelog for 15022 * Update docs/development/contributing_guide.md
* Allow enabling the asyncio reactor in complement (#14858)realtyem2023-02-011-0/+1
| | | Signed-off-by: Jason Little realtyem@gmail.com
* Require poetry>=1.3.2 (#14860)David Robertson2023-01-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Upgrade to new lockfile format Now requires poetry >= 1.2.2 to read and poetry >= 1.3.0 to write. Cheat sheet: ``` poetry --version poetry show > scratch/before pipx upgrade poetry poetry --version poetry show > scratch/after diff scratch{before,after} && echo "no change!" ``` * Use Poetry 1.3.2 when reading or writing lockfile * Remove unneeded(?) poetry dep for cibuildwheel * Update docs * Remove redundant call to setup-python * Remove outdated comments related to Poetry 1.x * Remove outdated docs line was fixed in #13082 * Minor improvements to poetry cheat sheet * Invoke setup-python-poetry with explicit version Not sure about this. It's hardcoding versions everywhere. * Changelog * Check the lockfile is version 2.0 Might one day incorporate other checks like #14742 * Typo fixes, thanks Sean Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com> Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
* Update link to towncrier in contribution guide (#14801)Dirk Klimpel2023-01-091-1/+1
| | | | | * Update link to towncrier in contribution guide * newsfile
* Fix broken links in the Synapse documentation. (#14744)reivilibre2023-01-051-5/+4
| | | | | | | | | | | | | | | | | * Fix stale external links * Fix some internal links * Fix URLs without trailing / where needed * Fix more links * Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> * Reapply docs/openid.md fix after conflict Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>
* Add release note and update doc regarding ICU (#14712)Mathieu Velten2022-12-201-0/+2
| | | | | Fixes #14704. Signed-off-by: Mathieu Velten <mathieuv@matrix.org>
* Allow override for requesting specific worker types for Complement on ↵realtyem2022-11-081-0/+6
| | | | | | | | | | | | | | | | | | | | | | | command line. (#14324) * Expose getting SYNAPSE_WORKER_TYPES from external, allowing override of workers requested. * Add WORKER_TYPES variable option to complement.sh script that passes requested workers into start_for_complement.sh entrypoint. * Update docs to reflect this new ability. * Changelog * Don't rely on soft wrapping to format long strings Good idea dklimpel. Thanks for catching that. Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> * Small nits just noticed in docs. * Fixup new line in docs. Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com>
* Handle `gottestfmt` repository move (#14144)David Robertson2022-10-111-1/+1
|
* The changelog entry ending in a `.` or `!` is not optional (#14087)Andre Klärner2022-10-061-1/+1
|
* Add instruction for running unit tests in parallel (#13928)Ashish Kumar2022-09-281-0/+6
|
* Add a stub Rust crate (#12595)Erik Johnston2022-09-061-1/+9
|
* Update lock file for Poetry v1.2.0 (#13689)Erik Johnston2022-09-021-0/+2
|
* Add information on how the Synapse team does reviews. (#13132)Patrick Cloke2022-07-061-1/+4
|
* Add the ability to set the log level using the `SYNAPSE_TEST_LOG_LEVEL` ↵reivilibre2022-07-051-0/+4
| | | | environment when using `complement.sh`. (#13152)
* Add instructions for running Complement with `gotestfmt`-formatted output ↵reivilibre2022-06-161-0/+14
| | | | locally. (#13073)
* Merge the Complement testing Docker images into a single, multi-purpose ↵reivilibre2022-06-081-0/+5
| | | | | image. (#12881) Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* contributing_guide.md: fix link to DCORichard van der Hoff2022-05-241-2/+2
|
* Suggest using docker when testing against postgres (#12765)David Robertson2022-05-171-3/+28
| | | Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
* Fix docs on how to run specific Complement tests after recent ↵Eric Eastwood2022-05-091-2/+2
| | | | `complement.sh` change (#12664)
* Recommend poetry in docs (#12475)David Robertson2022-04-201-21/+25
| | | | | | | | | | | * Recommend poetry in docs - readme - contributor guide - upgrade notes - new dev cheat sheet for poetry Co-authored-by: Shay <hillerys@element.io> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Allow specifying the Postgres database's port when running unit tests with ↵reivilibre2022-04-051-3/+11
| | | | Postgres. (#12376)
* Remove `dockerfile-pgtests` (#12336)David Robertson2022-03-311-21/+0
|
* Flesh out documentation for running SyTest against Synapse, including use of ↵reivilibre2022-03-301-1/+7
| | | | | Postgres and worker mode. (#12271) Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Note that contributors can sign off privately (#12204)Andrew Morgan2022-03-111-0/+11
| | | Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Docs: add missing PR submission process how-tos (#11821)Forest Johnson2022-01-251-1/+2
| | | | | | | * Docs: add missing PR submission process how-tos The documentation says that in order to submit a pull request you have to run the linter and links to [Run the linters](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#run-the-linters). IMO "Run the linters" should explain that development dependencies are a pre-requisite. I also included `pip install wheel` which I had to run inside my virtual environment on ubuntu before I `pip install -e ".[all,dev]"` would succeed.
* Mention python3-venv and libpq-dev dependencies in contribution guide (#11740)Andy Balaam2022-01-131-1/+3
|
* Document the `SYNAPSE_TEST_PERSIST_SQLITE_DB` unit test env var (#11715)Andrew Morgan2022-01-101-0/+21
|
* Clarify lack of Windows support in documentation (#11198)Sean Quah2021-10-291-6/+5
|
* Include the requirements for [mypy,lint] in [dev] (#11034)reivilibre2021-10-111-1/+1
|
* Revert accidental push to develop.Olivier Wilkinson (reivilibre)2021-10-081-1/+1
|
* Update contributing guide to use [all,dev]Olivier Wilkinson (reivilibre)2021-10-081-1/+1
|
* Add content to the Synapse documentation intro page (#10990)Andrew Morgan2021-10-061-1/+1
| | | Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* Update postgresql testing script (#10906)David Robertson2021-09-241-0/+47
| | | | | | | | | | | | | | | | | | - Use sytest:bionic. Sytest:latest is two years old (do we want CI to push out latest at all?) and comes with Python 3.5, which we explictly no longer support. The script now runs under PostgreSQL 10 as a result. - Advertise script in the docs - Move pg testing script to scripts-dev directory - Write to host as the script's exector, not root A few changes to make it speedier to re-run the tests: - Create blank DB in the container, not the script, so we don't have to `initdb` each time - Use a named volume to persist the tox environment, so we don't have to fetch and install a bunch of packages from PyPI each time Co-authored-by: reivilibre <olivier@librepush.net>
* Advertise matrix-org.github.io/synapse docs (#10595)David Robertson2021-08-311-5/+425
| | | | | Point to the book where possible, and use hyperlinks to github to refer to files not included in the book. Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* Compile and render Synapse's docs into a browsable, mobile-friendly and ↵Andrew Morgan2021-06-031-0/+7
searchable website (#10086)
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-11-16 02:37:42 +0000