MosaicIQ/MosaicIQ/src-tauri/vendor/yfinance-rs-0.7.2/CONTRIBUTING.md

Contributing to yfinance-rs

Thanks for considering a contribution to yfinance-rs! This guide helps you get set up and submit effective pull requests.

Code of Conduct

Please read and follow our Code of Conduct.

Getting Started

Prerequisites

• Rust (latest stable)
• Cargo
• Git
• Just command runner

Setup

git clone https://github.com/gramistella/yfinance-rs.git
cd yfinance-rs

Development Workflow

Test (full test, live recording + offline)

just test

Offline test

just test-offline

Lint & Format

just fmt
just lint

Commit Messages

Use Conventional Commits for clear history.

Pull Requests

1. Create a feature branch.
2. Add tests and documentation as needed.
3. Ensure CI basics pass locally (fmt, clippy, test).
4. Open a PR with a concise description and issue links.

Release

• Maintainers handle releases following Semantic Versioning.
• Update CHANGELOG.md with notable changes.

Support

Open an issue with details, environment info, and steps to reproduce.