Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (46 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

68 lines (46 loc) · 1.91 KB
Raw

Contributing to {REPO}

Thank you for your interest in contributing! This document provides guidelines for contributing to the project. All contributors are expected to follow our Code of Conduct.

Getting Started

  1. Fork and clone the repository:
git clone https://github.com/reflective-org/{REPO}.git
cd {REPO}
  1. Install Follow the installation instructions in the README.

Development Workflow

  1. Create a branch for your work using one of these prefixes:
git checkout -b feat/your-feature-name       # new feature
git checkout -b fix/your-bug-fix             # bug fix
git checkout -b docs/what-you-documented     # documentation only
git checkout -b test/what-you-tested         # adding/improving tests
git checkout -b refactor/what-you-refactored # restructure without behavior change
git checkout -b perf/what-you-optimized      # performance improvement

  1. Make your changes and ensure they pass all tests.

  2. Commit your changes with a clear message:

git commit -m "Add brief description of change"
  1. Push and open a pull request against the dev branch.

Code Style

  • PEP 8 with 4-space indentation
  • Type hints encouraged for public APIs
  • No enforced formatter yet; please match the surrounding style

Running Tests

-> Instructions on how to run your unit tests.

Writing Tests

  • Tests should live in tests/ and use pytest.
  • Shared fixtures and mocks should live in tests/conftest.py.
  • Mock any cloud or network calls; tests must run offline.
  • Aim for one test file per source module (e.g. test_storage.py for storage.py).

Reporting Issues

When reporting a bug, please include:

  • Python version
  • Package version
  • Steps to reproduce the issue
  • Full error traceback

License

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