nikdoof/leggen
1
1
Fork 0
mirror of https://github.com/elisiariocouto/leggen.git synced 2025-12-11 15:02:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
leggen/CONTRIBUTING.md
Elisiário Couto 83bb3fcef2 docs: Add instructions for shadcn/ui.
2025-09-19 11:24:49 +01:00

1.1 KiB
Raw Permalink Blame History

Contributing

This project uses uv for Python dependency management and shadcn/ui for frontend components.

Setup

Install uv and run uv sync to install dependencies.

Run pre-commit install to install the pre-commit hooks.

Frontend Development

The frontend uses shadcn/ui components for consistent design. When adding new UI components:

  • Check if a shadcn/ui component exists for your use case
  • Follow the existing component patterns in frontend/src/components/ui/
  • Use Tailwind CSS classes for styling
  • Ensure components are accessible and follow the design system

Commit messages

type(scope/[subscope]): Title starting with uppercase and sentence ending with period. More than 80 charactes use the body of the commit message.

Scope and subscopes are optional.

DO NOT use a bunch of different types: feat, fix, refactor should be more than enough.

Release new version

Run script scripts/release.sh <type_of_release>

Types supported are major, minor and patch. Semver practices must be followed. This release process deals with updating everything, including changelog generation.