matrix-org / matrix-org/synapse-module-cookiecutter-template
Concerns about maintaining many modules
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
As Matrix.org and Element, we expect to be maintaining quite a lot of modules.
I'm hoping this template can be useful to others, who would be perfectly fine with having everything in-repo and self-contained, but we are sufficiently concerned about drift in our own projects that we might want to move common pieces out of the modules' repositories and into something more centralised and maintainable.
This issue is about:
- figuring out what concerns us from a maintenance point of view (speaking from the perspective of maintaining many modules)
- figuring out what we can do about it (again, stuff that makes sense for us — perhaps not for someone only maintaining one or two modules)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or entry point is named in the issue. Start by reviewing the cookiecutter template and the repositories for the modules it supports, then document maintenance concerns and evaluate centralized alternatives; done means an agreed set of concerns and a practical approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100