addint CONTRIBUTING.md

Author: LevanBokeria

CONTRIBUTING.md

@@ -0,0 +1,47 @@
+See the [Scientific Python Developer Guide][spc-dev-intro] for a detailed
+description of best practices for developing scientific packages.
+
+[spc-dev-intro]: https://learn.scientific-python.org/development/
+
+# Setting up a development environment manually
+
+You can set up a development environment by running:
+
+```zsh
+python3 -m venv venv          # create a virtualenv called venv
+source ./venv/bin/activate   # now `python` points to the virtualenv python
+pip install -v -e ".[dev]"    # -v for verbose, -e for editable, [dev] for dev dependencies
+```
+
+# Post setup
+
+You should prepare pre-commit, which will help you by checking that commits pass
+required checks:
+
+```bash
+pip install pre-commit # or brew install pre-commit on macOS
+pre-commit install # this will install a pre-commit hook into the git repo
+```
+
+You can also/alternatively run `pre-commit run` (changes only) or
+`pre-commit run --all-files` to check even without installing the hook.
+
+# Testing
+
+This repo uses `unittest` for testing. You can run locally the tests by running the following command:
+
+```bash
+  python -m unittest discover -s tests
+```
+there is also a autamtated test pipeline that runs the tests on every push to the repository (see [here](.github/workflows/ci.yml)).
+
+
+# Pre-commit
+
+This project uses pre-commit for all style checking. Install pre-commit and run:
+
+```bash
+pre-commit run -a
+```
+
+to check all files.