57 lines (41 loc) · 1.21 KB

Contributing to dlmachine

Thanks for contributing to dlmachine.

Ground Rules

Use English in issues and pull requests.
Be respectful and constructive in discussions.
Before opening a new issue, search existing issues first.

Development Setup

Fork the repository and clone your fork.
Install dependencies:
```
poetry install
```
(Optional but recommended) Install pre-commit hooks:
```
pre-commit install
```

Running Checks Locally

Run tests:
```
poetry run pytest
```
Run lint checks:
```
poetry run flake8 dlmachine
```

Branches and Commits

Create a feature branch from main.
Keep commits focused and small.
Use clear commit messages that explain intent.

Pull Request Process

Ensure tests and lint pass locally.
Update docs/tests when behavior changes.
Fill out the pull request template completely.
Link related issues (for example: Closes #123).

Reporting Bugs and Requesting Features

Use the issue templates in .github/ISSUE_TEMPLATE:

Bug report
Documentation improvement
Feature request

Questions

If you're unsure about scope or implementation details, open an issue first so we can align before coding.