Contributing to libzip
We welcome contributions to libzip. Whether you want to report a bug, request a feature, or submit code changes, your input is valuable to us. Please read the following guidelines to ensure a smooth contribution process.
libzip is our hobby project and we work on it in our free time. It might take us a few weeks to review your contribution, so please be patient.
libzip is developed in the open on GitHub. We use GitHub issues to track bugs and feature requests, and pull requests for code contributions. Before starting a contribution, please check the existing issues and discussions to avoid duplication. Also, please follow the coding guidelines.
Ways to Get in Touch
There are several ways you can get in touch with us, each suited for different types of communication.
Pull Request
If you want to contribute code, the best way is to submit a pull request on GitHub.
If your change is large or complex, it is recommended to open an issue first to discuss the proposed changes. This helps ensure that your contribution aligns with the project's goals and gets accepted.
Issues
If you found a bug or have a feature request, please open an issue on GitHub. Make sure to provide as much detail as possible, including steps to reproduce the issue, expected behavior, and actual behavior.
If you plan to contribute code, especially if it is a large change, it is recommended to open an issue first to discuss the proposed changes. This helps ensure that your contribution aligns with the project's goals and gets accepted.
Discussions
For general discussions, questions, or community support, you can participate in the GitHub Discussions forum for the libzip project. This is a good place to ask for help, share ideas, and engage with other members of the community.
This is a good place to get in touch if you do not plan to contribute directly.
Security Advisory
If you discover a security vulnerability in libzip that you deem to be too sensitive to disclose publicly, please create a security advisory on GitHub.
Private eMail
For any non-public matters, questions, or concerns, you can also reach out to us directly via private email at info@libzip.org.
We prefer you use the other channels, since they are easier for us to track.