hiero-ledger / hiero-sdk-tck

A TCK (Technology Compatibility Kit) used to verify compliant implementations of a Hiero SDK
Apache License 2.0
20 stars 1 forks source link

`TCK`: Integrate Husky package #254

Closed ivaylogarnev-limechain closed 1 month ago

ivaylogarnev-limechain commented 1 month ago

Problem

Occasionally, contributors may unintentionally skip signing their commits, which can lead to significant challenges down the road, especially when managing complex pull requests with contributions from multiple people. If several commits are missing the required sign-off, it can create unnecessary complications during the merge process, ultimately increasing the time and effort needed to resolve the issue.

Solution

A potential solution to this problem is to leverage the Husky npm package. Husky can be configured to enforce signing off on commits and ensure that necessary pre-commit tasks, such as running linters or other validation scripts, are executed before the commit is finalized. This tool helps maintain code quality by automatically running tasks like linting or throwing an error if you try to commit without signing it.

ivaylogarnev-limechain commented 1 month ago

After implementing the Husky package and configuring it in a PR, we consulted with our DevOps team to enable a setting to complete the desired functionality. During this process, we discussed the use of Husky, and the team expressed strong reservations about its use. Based on their feedback, we’ve decided not to merge the PR with Husky. They recommended using the pre-commit tool as a more suitable alternative, which can achieve our goals. We’ve noted this and plan to implement it when we have the opportunity.