Contributing

We welcome contributions to the Sitepins platform! Follow these guidelines to ensure a smooth development process.

Branching Strategy

• main: The stable production branch.
• Feature Branches: Create branches from main using the format feature/your-feature-name.
• Bug Fixes: Use fix/issue-description.

Commit Guidelines

We follow conventional commit messages:

• feat: for new features.
• fix: for bug fixes.
• docs: for documentation changes.
• refactor: for code restructuring without changing behavior.

Code Style

• Use TypeScript for all new code.
• Follow the existing Tailwind CSS patterns for styling.
• Ensure all components are accessible (using Radix UI primitives where possible).
• Use RTK Query for any new API integrations.

Pull Request Process

1. Sync: Ensure your branch is up to date with main.
2. Test: Run yarn build locally to ensure no build errors.
3. Documentation: If your feature adds new environment variables or UI paths, update these docs!
4. Review: Open a PR and request review from the maintainers.