Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (34 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 1.63 KB

Contributing to INWARD

Thank you for your interest in contributing. Inward is built for paddlers who seek nature as a path back to themselves. Contributions that honor this spirit are especially welcome.

How to Contribute

  1. Open an issue describing the idea or bug.
  2. Wait for discussion — align before you code.
  3. Fork the repository and create a feature branch.
  4. Submit a pull request with a clear description.

Guidelines

  • Follow the existing code style (see CODE_STYLE.md)
  • Follow the design rules (see DESIGN_RULES.md)
  • All UI text must include i18n keys for both Portuguese and English
  • Keep the app fully offline — avoid external API dependencies for core features
  • Test on mobile — this is a water-based app used outdoors

Design Rules

  • No emojis in the interface or documentation
  • Use Lucide icons exclusively (no other icon libraries)
  • Follow the standardized card component system
  • Use semantic design tokens — never hardcode colors
  • Follow the 8-point spacing rhythm
  • All pages must use the card stage layout

For full design specifications, see docs/design-system.md and docs/ui-guidelines.md.

Development Setup

git clone https://github.com/your-username/inward-app.git
cd inward-app
npm install
npm run dev

Reporting Bugs

Use the bug report template.

Requesting Features

Use the feature request template.

Code of Conduct

Please read our Code of Conduct before participating.