Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (50 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

70 lines (50 loc) · 2 KB
Raw

Contributing to mtl-halbestunde-python-client

Thank you for your interest in contributing! This document provides guidelines and steps for contributing to this project.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

How to Contribute

Reporting Bugs

  1. Check existing issues to avoid duplicates
  2. Open a new issue using the Bug Report template
  3. Include steps to reproduce, expected vs. actual behavior, and environment details

Suggesting Features

  1. Open an issue using the Feature Request template
  2. Describe the use case and why the feature would be valuable

Submitting Changes

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature
  3. Make your changes following the coding standards below
  4. Write or update tests as needed
  5. Commit using Conventional Commits:
    • feat: new feature
    • fix: bug fix
    • docs: documentation
    • chore: maintenance
    • refactor: code restructuring
    • test: test changes
  6. Push and open a Pull Request against main

Branch Naming

Use prefixed branch names:

  • feature/ — new functionality
  • fix/ — bug fixes
  • chore/ — maintenance
  • docs/ — documentation

Coding Standards

  • Follow existing code patterns and conventions
  • No broad exception handling (catch specific exceptions)
  • Add appropriate error handling
  • Ensure tests pass before submitting

Pull Request Process

  1. Fill out the PR template completely
  2. Link related issues
  3. Ensure CI passes
  4. Request review from a maintainer
  5. Address review feedback promptly

Development Setup

See README.md for setup instructions.

Questions?

Open a discussion or reach out at musictechlab.io/contact.