Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (28 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 1.48 KB

Contributing to MeridianAlgo

First off, thank you for considering contributing to MeridianAlgo. It's people like you that make MeridianAlgo such a great tool.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

  • Search for existing issues: Check if the bug has already been reported.
  • Provide a clear description: Include steps to reproduce, expected behavior, and actual behavior.
  • Environment details: Mention your Python version, OS, and any relevant package versions.

Suggesting Enhancements

  • Open an issue: Describe the proposed change and why it would be beneficial.
  • Discussion: Engage with the community to refine the idea.

Pull Requests

  1. Fork the repository.
  2. Create a branch: Use a descriptive name (e.g., fix/bug-in-var-calc).
  3. Write tests: Ensure your changes are covered by tests.
  4. Follow style guidelines: Use ruff or flake8 for linting.
  5. Submit the PR: Provide a clear description of the changes and link any related issues.

Development Setup

  1. Clone the repository.
  2. Install dependencies: pip install -r requirements.txt.
  3. Install development tools: pip install -r dev-requirements.txt.
  4. Run tests: pytest tests/.

Style Guide

  • Follow PEP 8.
  • Use type hints for all public APIs.
  • Document classes and functions using NumPy/Google style docstrings.

Thank you for your contributions!