65 lines (46 loc) · 1.5 KB

Contributing to Petalytics

Thank you for your interest in contributing to Petalytics! This guide will help you get started.

Development Setup

Fork and clone the repository

git clone https://github.com/gitcoder89431/petalytics.git
cd petalytics

Install dependencies
```
npm install
```
Start development server
```
npm run dev
```

Code Style

TypeScript - Use TypeScript for all new code
ESLint - Follow the configured linting rules
Prettier - Code formatting is automated
Conventional Commits - Use conventional commit messages

Example commit messages:

feat: add AI analysis caching
fix: resolve pet image upload issue
docs: update README with new features

Testing

Write tests for new features
Run tests before submitting PRs: npm test
Ensure type checking passes: npm run check

Pull Request Process

Create a feature branch: git checkout -b feature/your-feature
Make your changes with proper tests
Update documentation if needed
Ensure CI passes locally
Submit a pull request with clear description

Areas for Contribution

AI Prompts - Improve breed-specific analysis
Themes - Add new color schemes
Mobile UX - Enhance mobile experience
Accessibility - Improve screen reader support
Testing - Add more comprehensive tests
Documentation - Improve guides and examples

Questions?

Open an issue or reach out to the maintainers!