Merge pull request #55 from Doist/tartandsandal/document-and-cleanup

chore: cleanup and document contributing and publishing

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+Thanks for helping us make Bitmapist work better.
+
+Please feel free to [report any issue](https://github.com/Doist/bitmapist/issues/new/choose) you may have.
+
+**Working on your first Pull Request?** You can learn how from this _free_
+series [How to Contribute to an Open Source Project on GitHub][egghead]
+
+If you want to contribute with code, please open a Pull Request. A few things to keep in mind:
+
+- The BSD project is released under the [BSD license](./LICENSE)
+- Please use [pre-commit](https://pre-commit.com/) to ensure some formatting rules and basic consistency checks are applied before each Git commit
+- Please add tests for your changes!
+- Please document any changes using the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention
+  - Changes in a PR should be documented under an `[Unreleased]` version
+  - We'll bump the version number and update the changelog in a separate PR when publishing

README.markdown → README.md

@@ -325,6 +325,41 @@ This will render something similar to this:
 ![bitmapist cohort screenshot](https://raw.githubusercontent.com/Doist/bitmapist/master/static/cohort_screenshot.png "bitmapist cohort screenshot")
 
 
+## Contributing
+
+Please see our guide [here](./CONTRIBUTING.md)
+
+## Local Development
+
+We use Poetry for dependency management & packaging.  Please see [here for setup instructions](https://python-poetry.org/docs/#installation).
+
+Once you have Poetry installed, you can run the following to install the dependencies in a virtual environment:
+
+```bash
+poetry install
+```
+
+## Testing
+
+To run our tests will need to ensure a local redis server is installed.
+
+We use pytest to run unittests which you can run in a poetry shell with
+
+```bash
+poetry run pytest
+```
+
+## Releasing new versions
+
+- Bump version in `pyproject.toml`
+- Update the CHANGELOG
+- Commit the changes with a commit message "Version X.X.X"
+- Tag the current commit with `vX.X.X`
+- Create a new release on GitHub named `vX.X.X`
+- GitHub Actions will publish the new version to PIP for you
+
+## Legal
+
 Copyright: 2012 by Doist Ltd.
 
 License: BSD

pyproject.toml

@@ -7,7 +7,7 @@ authors = [
     "Doist Developers <dev@doist.com>",
 ]
 license="BSD"
-readme = "README.markdown"
+readme = "README.md"
 homepage="http://www.amix.dk/"
 repository = "https://github.com/Doist/bitmapist"
 keywords=[ "redis", "bitmap", "analytics", "bitmaps", "realtime", "cohort", ]
@@ -27,7 +27,7 @@ packages=[ { include = "bitmapist" } ]
 exclude = ['tests/']
 include = [
     'AUTHORS',
-    'README.markdown',
+    'README.md',
     'static/bitmapist.png',
     'static/bitmapist.svg',
 ]