Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (26 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.15 KB

Contributing

Thank you for your interest in contributing to this project! Contributions are welcome and appreciated.

How to Contribute

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
  3. Create a feature branch: git checkout -b feature/amazing-feature
  4. Make your changes and commit with clear messages
  5. Push to your fork: git push origin feature/amazing-feature
  6. Open a Pull Request against the main branch

Development Setup

See the main README.md for installation and setup instructions.

Code Style

  • Follow existing code patterns and conventions
  • Use TypeScript strict mode
  • Add comments for complex logic or non-obvious decisions
  • Ensure code passes existing lints and builds

Testing

  • Test your changes thoroughly before submitting
  • Include relevant test cases if applicable
  • Verify the app works in development mode

Commit Messages

  • Use clear, descriptive commit messages
  • Start with a verb (Add, Fix, Update, Remove, etc.)
  • Keep the first line under 72 characters

Questions?

Feel free to open an issue for discussion before starting major work.