Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (30 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

39 lines (30 loc) · 1.34 KB

Contributing to ai-assert

Thank you for your interest in contributing to ai-assert! By participating, you agree to abide by our Code of Conduct.

How to Contribute

Reporting Bugs

  • Search existing issues before opening a new one.
  • Include a clear title, description, and steps to reproduce.
  • Add relevant labels if possible.

Suggesting Features

  • Open an issue with the enhancement label.
  • Describe the use case and expected behaviour.

Submitting Pull Requests

  1. Fork the repository and create a branch from main.
  2. Write clear, concise commit messages.
  3. Ensure all tests pass: pytest
  4. Sign off your commits (DCO): git commit -s -m "Your message"
  5. Open a pull request against main and fill in the PR template.

Attribution

All contributors will be credited in the project. By submitting a pull request, you confirm that your contribution is your own original work and that you have the right to license it under the MIT License.

Development Setup

git clone https://github.com/kaantahti/ai-assert.git
cd ai-assert
pip install -e .

Code Style

  • Follow PEP 8 for Python code.
  • Keep functions small and focused.
  • Add docstrings to public functions.

Questions?

Open an issue or reach out via kaantahti@users.noreply.github.com.