CONTRIBUTING.md•1.83 kB
# 🤝 Contributing to `mcp-yfinance-server`
Thanks for your interest in contributing to **`mcp-yfinance-server`**!
This project powers financial data access via Yahoo Finance APIs, and your help makes it better for everyone. Whether you’re fixing bugs 🐛, adding features 🌟, or writing docs 📝 — we’re excited to have you here.
---
## Code of Conduct
Please read our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a respectful and inclusive environment for all contributors.
---
## 🛠 Getting Started
1. **Fork** this repository and clone your fork locally:
```bash
git clone https://github.com/Adity-star/mcp-yfinance-server.git
cd mcp-yfinance-server
```
2. Install dependencies:
- Python (if using FastAPI, Flask, etc.):
```bash
pip install -r requirements.txt
```
- Node.js (if using Express, etc.):
```bash
npm install
```
3. Create a feature branch:
```bash
git checkout -b feature/your-feature-name
```
## Ways to Contribute:
- Fixing bugs
- Adding new features or endpoints
- Writing or improving tests
- Refactoring code for clarity or performance
- Enhancing the documentation
## Pull Requests Process
1. Push your changes to your fork:
```bash
git push origin feature/your-feature-name
```
2. Open a Pull Requests to the `main` branch of this repo.
3. In your PR Description:
- Reference the related issue (e.g., Closes #42)
- Describe what you changed and why
- Attach screenshots (if UI-related)
4. A maintainer will review, suggest edits, and merge after approval.
5. Make sure all tests pass before opening a PR.
## Thanks for Contributing!
Your time, ideas, and code make this project stronger.
We appreciate every contributor—whether it's your first PR or your hundredth!
> ✨ Let’s build something great together. ✨