Contribution Guidelines

Thank you for considering contributing to aPhyloGeo! We welcome your help in making this project even better.

How to Contribute

If you are new to open source, follow the next steps:

1. Fork the repository.
2. Create a new branch: git checkout -b feature-name.
3. Make your changes and commit them: git commit -m 'Add feature'.
4. Push to the branch: git push origin feature-name.
5. Submit a pull request.

Code Style

Please adhere to the coding style of the project. If in doubt, check the existing codebase.

Testing

Ensure that your contributions pass all existing tests. If you add new features, include relevant tests. To run tests, use the Makefile:

make test

Reporting Issues

If you find a bug or have a suggestion, please open an issue on the issue tracker. You can create your good first issue.

Development Setup

To set up the development environment, follow these steps:

1. install poetry if you dont already have it: The best practice is to install it with their setup: Poetry Setup OR it can be simply installed with pip install poetry.
2. Clone the repository: git clone https://github.com/tahiri-lab/aPhyloGeo.git.
3. Install dependencies: poetry install (poetry create and handle the Virtual Environment for you).
4. Open the Venv: poetry shell
5. (aphylogeo-py3.11) python.exe aphylogeo/main.py

License

By contributing, you agree that your contributions will be licensed under the MIT License.

---

Thank you for contributing to aPhyloGeo! We appreciate your time and effort.