Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (36 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

47 lines (36 loc) · 1.42 KB
Raw

Contributing

Thank you for your interest in contributing to @nish1896/rhf-mui-components 🎉
We welcome improvements, bug fixes, documentation updates, and new feature proposals.

📦 Development Setup

  1. Fork and clone the repository.
  2. Install dependencies and bootstrap the workspace: 
    sh scripts/setup.sh
  3. Create a new branch from main using the following format - v_a.b.c, for example, v_3.2.2.
  4. Update the version of all packages to match your release version by running: 
    sh scripts/bump-version.sh a.b.c
    Replace a.b.c with the version corresponding to your release branch, for example, 4.1.1.

🚀 Development Guidelines

  • Follow the existing project structure and coding patterns.
  • Keep changes focused and minimal.
  • Write clear commit messages.
  • Ensure TypeScript types remain strict and accurate.

🧪 Before Submitting a Pull Request

Please ensure the following:

  • ✅ All packages build successfully: 
    turbo build
  • ✅ Linting passes for all packages.
  • ✅ Documentation is added or updated where necessary.
  • ✅ Changes are reflected in the respective file in the changelog folder.

🔄 Pull Request Process

  • Open a Pull Request against the main branch.
  • Provide a clear description of the changes.
  • Reference related issues (if any).
  • Wait for review and feedback.

Thank you for helping improve the project 🙌