Verify that a commit message contains issue number with pre commit hook

[VahidGarousi]

Changes Introduced

1. Commit-Msg Hook:

   • Implements a commit-msg hook to validate commit messages.
   • Ensures all commit messages include an issue number in the format #123 or [ #123 ].
   • Provides clear examples of valid commit messages if validation fails, improving consistency across the team.

2. Integration with Clean Task:

   • Automatically installs Git hooks (pre-commit, commit-msg, pre-push) during the clean task.
   • Hooks are copied from the git-hooks directory to the .git/hooks directory.
   • Ensures that hooks are always up-to-date and available without requiring manual setup.

3. Git Hook Registration:

   • Adds the following Gradle functions to register and manage hooks:
     • configureGitHooks()
     • registerCopyPreCommitHookTask()
     • registerCopyPrePushHookTask()
     • registerCopyCommitMsgHookTask()
     • registerCopyGitHooksTask()
     • registerInstallGitHooksTask()

---

Usage Instructions

1. Install Git Hooks:

   • Run the clean task to automatically install or update hooks:

     ./gradlew clean

2. Commit-Msg Hook:

   • Ensures commit messages include an issue number (e.g., #123 or [ #123 ]).
   • Blocks commits with invalid messages.

---

Examples

Valid Commit Messages:

• Fix login issue #123
• [ #456 ] Refactor module

Invalid Commit Messages:

• Fix login issue (No issue number).
• Updated README 123 (Missing # prefix).

---

Why These Changes?

1. Improving Traceability:

   • The commit-msg hook enforces commit message standards, making it easier to link commits to specific issues.

2. Automating Hook Installation:

   • Integrating hook installation with the clean task reduces manual steps and ensures hooks are always up-to-date.

---

Directory Structure

project-root/
├── .git/
│   ├── hooks/
│       ├── pre-commit
│       ├── pre-push
│       ├── commit-msg
├── build.gradle.kts
├── git-hooks/
│   ├── pre-commit-unix.sh
│   ├── pre-commit-windows.sh
│   ├── pre-push-unix.sh
│   ├── pre-push-windows.sh
│   ├── commit-msg-unix.sh
│   ├── commit-msg-windows.sh