Contributing

You can contribute to this project with code.

To prepare your development environment:

1. Clone the source code:

   git clone https://github.com/zytedata/zyte-common-items.git
   cd zyte-common-items
   

2. Create and activate a Python virtual environment:

   python -m venv venv
   . venv/bin/activate
   

3. Install the packages needed for development:

   pip install -r requirements-dev.txt
   

4. Configure our Git pre-commit hooks:

   pre-commit install
   

You can search our issue tracker for pending work, and start a pull request for any pending issue that is not actively being worked on already, no need to ask for permission first.

If there is something else you wish to implement, please open an issue first to open a discussion about it, before you work on a pull request. You probably do not want to spend time on a pull request to later be told that the feature does not fit the project plans in the first place.