jessicaocean
CONTRIBUTING.md

Contributing to OUT App

Thank you for your interest in contributing to OUT! This document provides guidelines for contributing to the project.

Development Environment

This project is designed to run on Val Town. While you can view and edit the code locally, testing and deployment require a Val Town account.

Project Structure

  • backend/ - Server-side code using Hono framework
  • frontend/ - React-based user interface
  • shared/ - Code shared between frontend and backend
  • README.md - Project documentation

Code Style

  • Use TypeScript for all new code
  • Follow existing naming conventions
  • Add comments for complex logic
  • Ensure all React components are properly typed

Val Town Specific Considerations

  • Use Val Town's standard libraries when possible (@std/blob, @std/email, etc.)
  • Avoid Node.js specific APIs
  • Use https://esm.sh for npm dependencies
  • Test changes in Val Town environment before submitting

Submitting Changes

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test in Val Town environment
  5. Submit a pull request with a clear description

Questions?

Feel free to open an issue for any questions about contributing or the codebase.