Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (66 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

98 lines (66 loc) · 2.62 KB
Raw

Contributing to dvue

We love your input! We want to make contributing to dvue 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

Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

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 added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code follows the project's style guidelines.
  6. Issue that pull request!

Setting Up Development Environment

# Clone your fork
git clone https://github.com/your-username/dvue.git
cd dvue

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install in development mode with dev dependencies
pip install -e ".[dev]"

Code Style

We use the following tools to maintain code quality:

  • black: Code formatting (line length: 100)
  • isort: Import sorting
  • flake8: Linting
  • mypy: Type checking (optional)

Run these before committing:

black .
isort .
flake8 .

Testing

We use pytest for testing. Run tests with:

pytest

For coverage report:

pytest --cov=dvue --cov-report=html

Any contributions you make will be under the MIT License

When you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using GitHub's issue tracker

We use GitHub issues to track public bugs. Report a bug by opening a new issue.

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)

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft.