Contributing to PyTado

Thank you for considering contributing to PyTado! This document provides guidelines to help you get started with your contributions. Please follow the instructions below to ensure a smooth contribution process.

1. Prepare your development environment.
2. Ensure that you have installed the pre-commit hooks.

By following these steps, you can ensure that your contributions are of the highest quality and are properly tested before they are merged into the project.

Issues

If you encounter a problem or have a suggestion, please open a new issue. Select the most appropriate type from the options provided:

• Bug Report: If you've identified an issue with an existing feature that isn't performing as documented or expected, please select this option. This will help us identify and rectify problems more efficiently.

• Feature Request: If you have an idea for a new feature or an enhancement to the current ones, select this option. Additionally, if you feel that a certain feature could be optimized or modified to better suit specific scenarios, this is the right category to bring it to our attention.

• General Question: If you are unsure or have a general question, please join our GitHub Discussions.

After choosing an issue type, a pre-formatted template will appear. Provide as much detail as possible within this template. Your insights and contributions help improve the project, and we genuinely appreciate your effort.

Pull Requests

PR Title

We follow the conventional commit convention for our PR titles. The title should adhere to the structure below:

[optional scope]: 

The common types are:

• feat (enhancements)
• fix (bug fixes)
• docs (documentation changes)
• perf (performance improvements)
• refactor (major code refactorings)
• tests (changes to tests)
• tools (changes to package spec or tools in general)
• ci (changes to our CI)
• deps (changes to dependencies)

If your change breaks backwards compatibility, indicate so by adding ! after the type.

Examples:

• feat(cli): add Transcribe command
• fix: ensure hashing function returns correct value for random input
• feat!: remove deprecated API (a change that breaks backwards compatibility)

PR Description

After opening a new pull request, a pre-formatted template will appear. Provide as much detail as possible within this template. A good description can speed up the review process to get your code merged.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank you for your contributions!