Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add contributer docs for using the provided linters script #6164

Merged
merged 5 commits into from
Nov 1, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
* [ ] Pull request is based on the develop branch
* [ ] Pull request includes a [changelog file](https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.rst#changelog)
* [ ] Pull request includes a [sign off](https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.rst#sign-off)
* [ ] Code style is correct (run the [linters](https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.rst#code-style))
8 changes: 8 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,14 @@ Please ensure your changes match the cosmetic style of the existing project,
and **never** mix cosmetic and functional changes in the same commit, as it
makes it horribly hard to review otherwise.

Before doing a commit, ensure the changes you've made don't produce
linting errors. You can do this by running the linters as follows. Ensure to
commit any files that were auto-corrected.
jaywink marked this conversation as resolved.
Show resolved Hide resolved

::

jaywink marked this conversation as resolved.
Show resolved Hide resolved
./scripts-dev/lint.sh

Changelog
~~~~~~~~~

Expand Down
1 change: 1 addition & 0 deletions changelog.d/6164.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Contributor documentation now mentions script to run linters.
1 change: 1 addition & 0 deletions synapse/python_dependencies.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
"sentry": ["sentry-sdk>=0.7.2"],
"opentracing": ["jaeger-client>=4.0.0", "opentracing>=2.2.0"],
"jwt": ["pyjwt>=1.6.4"],
"lint": ["black", "flake8", "isort"],
jaywink marked this conversation as resolved.
Show resolved Hide resolved
}

ALL_OPTIONAL_REQUIREMENTS = set() # type: Set[str]
Expand Down