Make A Contribution

Introduction

Thank you for your interest in contributing to IPTpy. There are many ways to get involved, including reporting bugs, suggesting new features, improving documentation, or contributing code. We appreciate all your contributions. If you have any questions, please feel free to reach out via GitHub Discussions.

Where to Start

Browse our open issues to find one that interests you. We recommend collaborating with use when implementing new functionality, as we can help you get started and ensure your code aligns with the project structure. While we do not officially “assign” issues, please comment on an issue if you plan to work on it to help prevent duplicate efforts.

IPTpy is hosted on GitHub. If you do not have an account, you will need to create a free GitHub account. The GitHub Quickstart Guide is an excellent resource for getting familiar with Git and GitHub.

Reporting Bugs

Encounting an issue? We would love to hear about it! Please report any bugs by opening an issue on GitHub.

When reporting a bug, provide as much detail as possible, including steps to reproduce the issue, expected behavior, and any relevant error messages. This will help us diagnose and resolve the problem more efficiently.

Improving Documentation

We are always looking to enhance our documentation. If you come across anything unclear or confusing, please let us know by opening an issue on GitHub. Your feedback helps us improve.

Development Workflow Overview

Here is a brief overview of the development workflow for IPTpy.

Set up Your Development Environment

• Fork and clone the repository.

• Create a development environment.

• Create a new branch for your changes.

• Install pre-commit hooks.

Implement Your Changes

• Familiarize yourself with the codebase.

• Make and test your modifications.

Contribute your code

• Push your changes to your fork.

• Open a pull request.

• Address any feedback from reviewers.

• Wait for your pull request to be merged.