Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (53 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

78 lines (53 loc) · 1.96 KB

Contributing to YourFinanceWORKS

First off, thank you for considering contributing to YourFinanceWORKS! It's people like you that make this tool great for everyone.

Code of Conduct

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

How Can I Contribute?

Reporting Bugs

  • Check the Issues to see if the bug has already been reported.
  • If not, open a new issue. Include a clear title, a detailed description, steps to reproduce, and any relevant logs or screenshots.

Suggesting Enhancements

  • Open an issue with the tag "enhancement".
  • Describe the feature you'd like to see and why it would be useful.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Development Setup

Prerequisites

  • Python 3.11+
  • Node.js 18+
  • Docker & Docker Compose

Backend Setup

cd api
python -m venv venv
source venv/bin/activate  # Or venv\Scripts\activate on Windows
pip install -r requirements.txt
cp .env.example.full .env
# Update .env with your local settings
python main.py

Frontend Setup

cd ui
npm install
cp .env.example .env
npm run dev

Running with Docker

cp api/.env.example.full .env
docker-compose up -d

Styling and Standards

  • Python: Follow PEP 8 and use ruff for linting.
  • TypeScript: Use functional components and follow the project's existing ESLint configuration.
  • CSS: Use Tailwind CSS classes.

Licensing & CLA

By contributing to YourFinanceWORKS, you agree that:

  1. Your contributions will be licensed under the project's AGPL-3.0 / Commercial dual-license.
  2. You agree to the terms of our Contributor License Agreement (CLA).

Submitting a Pull Request constitutes your agreement to these terms.