Use rstcheck to "lint" the README - Githubissues

element-hq / synapse

Synapse: Matrix homeserver written in Python/Twisted.

https://element-hq.github.io/synapse

GNU Affero General Public License v3.0

963 stars 109 forks source link

Use rstcheck to "lint" the README #17367

Closed S7evinK closed 4 days ago

S7evinK commented 4 days ago

Follow up to https://github.com/element-hq/synapse/pull/17363, so we can detect issues with the RST file early on.

Pull Request Checklist

[x] Pull request is based on the develop branch
[x] Pull request includes a changelog file. The entry should:
- Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
- Use markdown where necessary, mostly for code blocks.
- End with either a period (.) or an exclamation mark (!).
- Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
[x] Code style is correct (run the linters)