Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (34 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

47 lines (34 loc) · 1.06 KB

Contributing

Thank you for your interest in contributing to fastapi-fullstack!

Development Setup

  1. Clone the repository:

    git clone https://github.com/vstorm-co/full-stack-ai-agent-template.git
cd full-stack-ai-agent-template

  2. Install dependencies:

    uv sync --dev

  3. Run tests:

    pytest

Code Style

  • Use ruff for linting and formatting
  • Run ruff check . and ruff format . before committing
  • Type hints are required for all public functions

Pull Request Process

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/your-feature)
  3. Make your changes
  4. Run tests and linting
  5. Commit with a descriptive message
  6. Push to your fork
  7. Open a Pull Request

Reporting Issues

  • Use GitHub Issues for bug reports and feature requests
  • Include reproduction steps for bugs
  • Check existing issues before creating a new one

License

By contributing, you agree that your contributions will be licensed under the project's license.