From bb1921262ecaed73f95c3d7954b62fc5511d70de Mon Sep 17 00:00:00 2001
From: Adar Nimrod <nimrod@shore.co.il>
Date: Sun, 1 Aug 2021 00:26:30 +0300
Subject: [PATCH] Document development and release.

---
 Makefile   |  4 ++++
 README.rst | 31 +++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+)

diff --git a/Makefile b/Makefile
index 8f762c1..f8dabc7 100644
--- a/Makefile
+++ b/Makefile
@@ -7,3 +7,7 @@ dist/mnpw: mnpw/*.py pyproject.toml *.rst LICENSE.txt
 .PHONY: clean
 clean:
 	git clean --force -X -d
+
+.PHONY: bats
+bats: all
+	bats tests/
diff --git a/README.rst b/README.rst
index 943f2ac..cc42195 100644
--- a/README.rst
+++ b/README.rst
@@ -48,6 +48,37 @@ plugin handling useful and would want to use it. The package is not published to
 PyPI so your best option is getting a direct download of the wheel package from
 the `releases pages <https://git.shore.co.il/shore/mnpw/-/releases>`_.
 
+Development
+-----------
+
+For local development, the following is required:
+
+- Python 3.6 or newer.
+- `Poetry <https://python-poetry.org/>`_.
+- `Bats <https://bats-core.readthedocs.io/en/stable/>`_.
+- Make.
+
+To run all of the tests locally:
+
+.. code:: shell
+
+   poetry install
+   poetry run pre-commit run --all-files
+   poetry run pytest
+   poetry run make bats
+
+All of those tests (and more) run in the `CI pipeline
+<https://git.shore.co.il/shore/mnpw/-/pipelines>`_ on each push.
+
+To release a new verion:
+
+.. code:: shell
+
+    poetry run bumpversion major|minor|patch
+
+This will commit the version change, tag and push it and the pipeline will
+release a new version.
+
 License
 -------
 
-- 
GitLab