Commit Graph

11 Commits

Author SHA1 Message Date
David Teller
9e19c6aab4
Reorganize CONTRIBUTING.md documentation. () 2021-02-17 11:23:57 -05:00
Andrew Morgan
2a6b685294
Add documentation about documentation to CONTRIBUTING.md ()
This PR adds some documentation that:

* Describes who the audience for the `docs/`, `docs/dev/` and `docs/admin/` directories are, as well as Synapse's wiki page.
* Stresses that we'd like all documentation to be down in markdown.
2020-11-06 11:59:22 +00:00
kleph
29ce6d43b5
Run mypy as part of the lint.sh script. () 2020-10-28 08:49:08 -04:00
Andrew Morgan
654e239b25
Add option to scripts-dev/lint.sh to only lint files changed since the last git commit ()
This PR makes several changes to the `./scripts-dev/lint.sh` script, which lints the codebase with a number of tools:

* Adds usage information, with `-h` flag to show it. Otherwise it will show when providing an unknown flag.
* Adds option `-d` which will check both staged and unstaged files that have changed since the last commit and add them to the list of files to lint.
  - Note that only files without an extension, or with a `.py` extension will be allowed. This prevents editing bash scripts causing the linters to break on non-python files.
* Improves the print-out of which files/directories are being linted.
2020-10-15 15:45:13 +01:00
Jonathan de Jong
efb6b6629c
Move lint dependencies to extras_require ()
Lint dependencies can now be installed with pip install -e ".[lint]"

This should help keep the version in sync between tox and documentation.
2020-09-17 16:45:22 -04:00
Richard van der Hoff
5db2a59a86
Update CONTRIBUTING.md () 2020-05-20 18:47:19 +01:00
Richard van der Hoff
66d03639dc
Notes on using git ()
* general updates to CONTRIBUTING.md
* notes on updating your PR
* Notes on squash-merging or otherwise
* document git branching model
2020-05-14 18:03:10 +01:00
Patrick Cloke
509e381afa
Clarify list/set/dict/tuple comprehensions and enforce via flake8 ()
Ensure good comprehension hygiene using flake8-comprehensions.
2020-02-21 07:15:07 -05:00
Michael Kaye
c87572d6e4
Update CONTRIBUTING.md about merging PRs. () 2020-02-04 16:21:09 +00:00
Andrew Morgan
7b14c4a018
Add tips for the changelog to the pull request template () 2020-01-16 09:46:36 +00:00
Andrew Morgan
c1ae453932
Markdownification and other fixes to CONTRIBUTING () 2019-12-04 12:21:48 +00:00