Contributing

We welcome contributions to mets! This document outlines the process for contributing to this project.

Setting up your development environment

1. Fork the repository on GitLab.

2. Clone your fork locally:

   git clone https://gitlab.com/your-username/mets.git
   cd mets
   

3. Create a virtual environment and install the development dependencies:

   python -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
   pip install -e .[test]
   

Running tests

We use pytest for our test suite. To run the tests:

pytest

Coding standards

We follow PEP 8 for code style. Please ensure your code adheres to these standards.

We use Black for code formatting. Before submitting a pull request, please run:

black src/mets

Submitting changes

1. Create a new branch for your changes:

   git checkout -b name-of-your-bugfix-or-feature
   

2. Make your changes and commit them:

   git commit -m "Your detailed description of your changes."
   

3. Push your branch to GitLab:

   git push origin name-of-your-bugfix-or-feature
   

4. Submit a pull request through the GitLab website.

Thank you for your contributions!