Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (29 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.07 KB

Contributing

Thanks for contributing to this project.

Getting Started

  1. Install dependencies with npm install
  2. Start the project with npm run dev
  3. Make your changes in a separate branch

Before You Submit

Please make sure the project still works and run:

  • npm run lint
  • npm run test
  • npm run build

Code Style

  • Use the existing project structure and naming patterns
  • Keep changes focused and relevant to the task
  • Use TypeScript and avoid unnecessary any
  • Reuse existing components and styles when possible
  • Format code with npm run format if needed

Pull Requests

  • Write a short and clear PR description
  • Explain what you changed
  • Mention any known limitations or unfinished work
  • Keep pull requests small and easy to review when possible

Project Structure

  • src/components for shared components
  • src/features for feature-specific code
  • src/styles for global styles and tokens
  • src/testing for tests and setup

Notes

This is a school project, so the goal is clean structure, readable code, and steady improvement over time.