Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.85 KB
Raw

Contributing to immosheets

Thank you for considering contributing to immosheets! Every contribution, whether a typo fix or a new feature, is valuable for the project. This document provides guidelines and steps for contributing.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

  1. Ensure the bug was not already reported by searching on GitHub under Issues.
  2. If you're unable to find an open issue addressing the problem, open a new one. Include a clear title, detailed description, and as much relevant information as possible.

Suggesting Enhancements

  1. First, read the documentation to ensure the feature hasn't been discussed or implemented.
  2. Propose your new feature in an issue. Include design mockups or diagrams if applicable.

Pull Requests

  1. Fork the repository and create your branch from main.
  2. Ensure the test suite passes using pytest.
  3. Issue that pull request!

Development Setup

  1. Fork and clone the repository.
  2. Install the required dependencies using pip install -r requirements.txt.
  3. Make your changes and test them.
  4. Submit your pull request.

Styleguides

Git Commit Messages

  • Start the commit message with an appropriate gitmoji. For example: 🐛: Fix a bug or ✨: Add new feature.
  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the initial message.

Python Styleguide

All Python code must adhere to the PEP 8 style guide.