Contributor's guide and maintainer's guide

Author: dahlia

CONTRIBUTING.rst

@@ -0,0 +1,61 @@
+Contributor's guide
+===================
+
+Coding style
+------------
+
+- Follow `PEP 8`_.  flake8_ would help.
+- Order imports by lexicographical order.
+- Prefer relative imports.
+- All functions, classes, methods, attributes, and modules should have
+  the docstring.
+- Functions and methods should contain ``:param:``, ``:type:``
+  (``:return:``, ``:rtype`` if it returns something),
+  (``:raise:`` if it may raise an error) in their docstring.
+
+.. _flake8: https://gitlab.com/pycqa/flake8
+.. _PEP 8: www.python.org/dev/peps/pep-0008
+
+
+Tests
+-----
+
+- All code patches should contain one or more unit tests or regression tests.
+- All code patches have to successfully run tests on every Python version
+  we aim to support.  tox_ would help.
+- All commits will be tested by Travis_ (Linux) and
+  AppVeyor_ (Windows).
+
+.. _tox:  http://tox.testrun.org/
+.. _Travis: http://travis-ci.org/dahlia/libsass-python
+.. _AppVeyor: https://ci.appveyor.com/project/dahlia/libsass-python
+
+
+Maintainer's guide
+==================
+
+Releasing
+---------
+
+Here's a breif check list for releasing a new version.
+
+- Double check the version is correctly bumped.
+  You can bump the version by changing ``__version__`` in sass.py file.
+  Note that it might be already bumped by other maintainers,
+  so check what's the latest release version from PyPI_.
+- If the code freeze for the release is done (including version bump),
+  tag the commit using ``git tag`` command.  The tag name has to simply be
+  the version name e.g. ``1.2.3``.  Of course, the tag also has to be pushed
+  to the upstream repository.
+- Make a source distribution and upload it to PyPI
+  (``python3 setup.py sdist upload``).
+  If it's successful the new version must appear on PyPI_.
+- AppVeyor_ automatically makes binary wheels for Windows, but each CI build
+  takes longer than an hour.  These wheels are not automatically uploaded,
+  but there's upload_appveyor_builds.py script that downloads built wheels and
+  uploads them to PyPI.
+
+Ping Hong Minhee (hongminhee@member.fsf.org, @dahlia on GitHub) if you need
+any help!
+
+.. _PyPI: https://pypi.python.org/pypi/libsass