This repository was archived by the owner on Apr 26, 2024. It is now read-only.
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
Improve contributor docs with reference to Rust #15667
Description
Description
I ran into trouble setting up a development environment but following the docs in develop/docs/development/contributing_guide.md. Admittedly the problems were due to poor reading comprehension on my part, but some clarifications in the documentation might help.
Steps to reproduce
- Skim the documentation and completely fail to see the mention of Rust
- Run
poetry installand watch it fail due to needing Rust - Fix some things, but fail to get a clean run of
poetry install
Homeserver
Local development environment
Synapse Version
1.84.0rc1 (b=develop,1903c7e5e)
Installation Method
pip (from PyPI)
Database
A single PostgreSQL server, with a new clean DB
Workers
Single process
Platform
Development environment running directly in the host OS (no VM or container) on Ubuntu 20.04
Configuration
No unusual configs
Relevant log output
$ poetry run python -m synapse.app.homeserver -c homeserver.yaml
Traceback (most recent call last):
File "/usr/lib/python3.8/runpy.py", line 185, in _run_module_as_main
mod_name, mod_spec, code = _get_module_details(mod_name, _Error)
File "/usr/lib/python3.8/runpy.py", line 111, in _get_module_details
__import__(pkg_name)
File "/home/grant/projects/synapse/synapse/app/__init__.py", line 18, in <module>
from synapse.util import check_dependencies
File "/home/grant/projects/synapse/synapse/util/check_dependencies.py", line 58, in <module>
set(metadata.metadata(DISTRIBUTION_NAME).get_all("Provides-Extra")) - DEV_EXTRAS
File "/usr/lib/python3.8/importlib/metadata.py", line 520, in metadata
return Distribution.from_name(distribution_name).metadata
File "/usr/lib/python3.8/importlib/metadata.py", line 177, in from_name
raise PackageNotFoundError(name)
importlib.metadata.PackageNotFoundError: matrix-synapseAnything else that would be useful to know?
I have the makings of a pull request here:
https://github.com/grantm/synapse/tree/grantm/contributor-docs