Thank you for your interest in contributing to Brompt! We welcome contributions from everyone.
- Fork the repository on GitHub.
- Clone your fork locally:
git clone https://github.com/your-username/brompt.git cd brompt - Install dependencies using
pnpm:This project usespnpm install
pnpmexclusively. If you don't have it installed, you can enable it via corepack:corepack enable
- Create a branch for your feature or fix:
git checkout -b feature/your-feature-name
- Make your changes.
- Run checks to ensure code quality:
This runs type checking and linting.
pnpm check
- Commit your changes.
We use
huskyandlint-stagedto automatically format and lint your code before committing. Please follow conventional commits if possible (e.g.,feat: add new button,fix: resolve crash).
- Push your branch to your fork:
git push origin feature/your-feature-name
- Open a Pull Request against the
mainbranch of the original repository. - Fill out the Pull Request Template with details about your changes.
- We use Prettier for code formatting.
- We use ESLint for linting.
- We use TypeScript for type safety.
Configuration files:
.prettierrc.editorconfigtsconfig.json
Happy coding!