Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (68 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

93 lines (68 loc) · 1.71 KB
Raw

Contributing to Inference-LAB

Thanks for your interest in contributing to Inference-LAB.

We welcome contributions across:

  • AI/ML research
  • model development
  • datasets
  • tooling
  • documentation
  • evaluation
  • infrastructure

Ways to Contribute

You can contribute by:

  • Opening issues
  • Improving documentation
  • Fixing bugs
  • Adding features
  • Training or evaluating models
  • Creating datasets
  • Improving benchmarks
  • Reviewing pull requests

Before You Start

Please:

  • Search existing issues before opening a new one
  • Keep discussions constructive
  • Open an issue before working on major changes

Development Workflow

  1. Fork the repository
  2. Create a feature branch
git checkout -b feature/my-feature
  1. Make your changes
  2. Commit clearly
git commit -m "Add feature X"
  1. Push and open a Pull Request

Pull Request Guidelines

PRs should:

  • Be focused and small when possible
  • Include clear descriptions
  • Reference related issues
  • Pass tests/checks
  • Avoid unrelated refactors

Coding Standards

General expectations:

  • Write readable and modular code
  • Prefer type hints where useful
  • Add comments only when necessary
  • Keep dependencies minimal

For Python:

  • Follow PEP8
  • Use virtual environments
  • Prefer black/ruff formatting

Reporting Bugs

When opening a bug report, include:

  • Expected behavior
  • Actual behavior
  • Reproduction steps
  • Environment details

Security

Do not publicly disclose security vulnerabilities. Please report them privately to the maintainers.

Community

Be respectful and collaborative. Constructive technical discussion is encouraged.

License

By contributing, you agree that your contributions will be licensed under the repository license.