Contributing

Thank you for your interest in contributing to record-shelf! This guide will help you get started.

Getting Started

Please see our detailed Contributing Guide on GitHub for complete instructions.

Quick Start for Contributors

  1. Fork and Clone

    git clone https://github.com/bryankemp/record-shelf.git
    cd record-shelf
    
  2. Set Up Development Environment

    make setup
    source venv/bin/activate
    
  3. Run Tests

    make test
    
  4. Check Code Quality

    make dev-test
    

Contribution Types

We welcome several types of contributions:

  • Bug Reports: Help us identify and fix issues

  • Feature Requests: Suggest new functionality

  • Code Contributions: Submit bug fixes or new features

  • Documentation: Improve or expand documentation

  • Testing: Add or improve test coverage

Development Workflow

  1. Create a feature branch

  2. Make your changes

  3. Run tests and quality checks

  4. Submit a pull request

Code of Conduct

This project follows the Contributor Covenant Code of Conduct.

Questions?

If you have questions:

For complete details, please see the CONTRIBUTING.md file in the repository.