45 lines (32 loc) · 1.29 KB

Contributing to lintlang

Thank you for your interest in contributing to lintlang.

Reporting Bugs

Search existing issues first to avoid duplicates.
Open a new issue with a clear title and description.
Include steps to reproduce, expected behavior, and actual behavior.
Attach sample input files if relevant.

Submitting Pull Requests

Fork the repository.
Create a feature branch from main (git checkout -b my-feature).
Make your changes with clear, focused commits.
Add or update tests for any new functionality.
Run the full test suite before submitting:
```
pytest
```
Open a pull request against main with a clear description of the change.

Code Style

We use ruff for linting and formatting.
Run ruff check . and ruff format . before committing.
Type hints are required on all public functions.
Use from __future__ import annotations in all modules.

Testing

All tests use pytest.
Run with coverage: pytest --cov=lintlang --cov-report=term-missing
New features must include test coverage.

Development Setup

pip install -e ".[dev]"

Questions?

Open an issue or start a discussion on the repository.