Dear Contributor!

I am happy that you think about contributing to this project. This is a good idea, keep reading!

How can I contribute?

Propose new features.
Report or fix bugs.
Develop the code.
Create documentation.
Promote horology 💗

How to report a bug or propose a new amazing feature?

Create an issue.

How to commit some code?

Fork horology.
Create a branch.
Create virtual env with conda using latest version of supported python, e.g.:
```
conda create -n horology python=3.12
conda activate horology
```
Install poetry using pip:
```
pip install poetry
```
Use poetry to install all dev dependencies:
```
poetry install
```
Write some useful and beautiful code that follows PEP8.
Write unit tests.
Run mypy and pytest and fix eventual errors:
```
mypy .
pytest
```
Commit and push your changes (in your fork).
Create a pull request from your fork to horology.
Wait for my feedback.
If I accept your changes, I will merge them into the master branch and release with the next release.

How to write some documentation?

Follow numpy style, but no space before a colon ;)

Commit messages

Follow the rules when writing a commit message:

use the imperative mood in the first line of commit message,
capitalize the first line,
do not end the first line with a period,
limit the first line to 72 characters,
separate the first line from the body with one blank line.

adopted from here.

I am open

Feel free to connect. My email starts with maciej.mikulski.jr and ends with gmail.com.