Skip to content

Latest commit

 

History

History
102 lines (68 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

102 lines (68 loc) · 2.64 KB

Contributing to Segmind

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Communication Channel

You can use Discord to communicate with us. Join our discord server here

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests. Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've changed APIs, update the documentation.
  3. Issue that pull request!

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Coding Style

This project uses pre-commit hooks to ensure style consistency and prevent common mistakes. Enable it by:

pre-commit install

After this pre-commit hooks will be run before every commit.

You can also run this manually on every file using:

pre-commit run --all-files

Commit format

Please follow conventional commits specification for descriptions/messages.

Development Workflow

Setting Up Your Development Environment

  1. Fork the repository and clone your fork
  2. Install development dependencies: 
    pip install -e ".[test,dev]"
  3. Install pre-commit hooks: 
    pre-commit install

Running Tests

Before submitting a pull request, ensure all tests pass:

# Run all tests
make test

# Run with coverage
make test-coverage

Code Quality Checks

Run linting and formatting checks:

# Run all pre-commit checks
make lint

# Or manually
pre-commit run --all-files

Release Process

If you are a maintainer with publishing permissions, see RELEASING.md for detailed instructions on creating releases and publishing to PyPI.

Regular contributors do not need to worry about releases - maintainers will handle versioning and publishing.