Contributing

Contributions to xypattern are welcome! Here’s how you can contribute:

Setting up the development environment

1. Fork the repository on GitHub

2. Clone your fork locally:

   git clone https://github.com/your-username/xypattern.git
   cd xypattern
   

3. Install the development dependencies:

   poetry install
   

Running tests

Run the tests using pytest:

poetry run pytest

Code style

Please follow the existing code style. We recommend using tools like:

• black for code formatting

• isort for import sorting

• flake8 for linting

Submitting changes

1. Create a branch for your changes:

   git checkout -b feature-or-bugfix-name
   

2. Make your changes and commit them:

   git commit -m "Description of your changes"
   

3. Push your branch to GitHub:

   git push origin feature-or-bugfix-name
   

4. Submit a pull request through the GitHub website.