-
Notifications
You must be signed in to change notification settings - Fork 36
Description
Note
You can now preview the latest updates and improvements every 2β3 days at the following link:
π Helixque-Landing
Describe the feature you'd like
Add Husky pre-commit hooks to the repository, enabling automated linting, formatting, or tests before each commit. This helps enforce code quality and prevent errors from being committed, ensuring the codebase remains clean and consistent for all contributors.
Describe alternatives you've considered
- Relying on manual git hooks, which are not shareable or versioned and require each contributor to set them up individually.
- Using only CI-based checks via GitHub Actions, which catch issues after the code is pushed, not before it enters the repository.
- Implementing commit message linting or branch name validation as other types of hooks.
Additional context
-
Husky is a popular open-source tool used across many JavaScript/TypeScript projects.
Typical setup steps: -
npm install husky --save-dev -
npx husky init && npm install -
Edit .husky/pre-commit and add commands like npm run lint or npm test to automate checks.
Screenshots, starter commands, or custom hook examples can be provided as needed.
This feature will boost code quality and speed up contribution workflows, and aligns with best practices for modern open source projects.
Prerequisite Checklist
- β Starred Helixque Repo
- β Starred Helixque Landing Repo
- π Read and understood Contributing Guidelines
- π¬ Joined Discord Channel
- π Explored and signed up on helixque.netlify.app
β Issues will be assigned once all checklist prerequisites are verified.
Important
π Contribution Guidelines β Please Read Before Proceeding
- Any PR raised for an unassigned issue (even if the issue number is mentioned in the PR) will not be merged and will be closed automatically.
- If your issue is valid but not yet assigned, please ping the Project Maintainers in the Discord Channel to get it assigned before starting work or submitting a PR.
- Only Code Owners or Project Maintainers have the authority to verify, approve, and assign issues.
- Do not self-assign issues β any self-assigned issue will be reviewed, and the final decision will rest with the Code Owners.
Thank you for helping shape HelixQueβs future this Hacktoberfest π
Note
You can now preview the latest updates and improvements every 2β3 days at the following link:
π Helixque-Changes