Merge branch 'master' into darken-deprecation

CONTRIBUTING.rst

@@ -0,0 +1,37 @@
+========================
+ Contributing to Darker
+========================
+
+This is a micro project with a small code base, few contributors and hobby maintainership.
+For this reason, please don't expect immediate responses to bug reports and pull requests.
+They will all be responded to eventually.
+
+We follow common conventions and code of conduct for Open Source collaboration on GitHub.
+
+Some additional simple guidelines:
+
+Bug reports
+===========
+
+Please include
+
+- release or Git commit for the version of Darker you're using
+- Python, black and isort versions
+- your command line
+- file to be formatted as an attachment, if possible – also great if squeezed down to a minimal example
+- resulting output or error message
+- expected output
+
+Pull requests
+=============
+
+To speed up review and increase odds for the PR to be accepted, please
+
+- keep all code black & isort formatted
+- include a test case for new or modified code
+- use type hinting
+- make sure the test suite passes
+- verify that mypy static type checking passes
+- document new features or changed behavior in ``README.rst``
+- summarize end-user affecting changes in ``CHANGES.rst``
+- add your information in ``CONTRIBUTORS.rst``

CONTRIBUTORS.rst

@@ -0,0 +1,7 @@
+========================
+ Contributors to Darker
+========================
+
+(in alphabetic order and with GitHub handles)
+
+- Antti Kaihola (@akaihola)

README.rst

@@ -192,3 +192,12 @@ Prior art
 __ https://github.com/wbolster/black-macchiato
 __ https://github.com/Carreau/darken
 __ https://github.com/Carreau
+
+
+GitHub stars trend
+==================
+
+|stargazers|_
+
+.. |stargazers| image:: https://starchart.cc/akaihola/darker.svg
+.. _stargazers: https://starchart.cc/akaihola/darker