epam / epam/cloud-pipeline

Release Notes Agent: Pre-commit hooks

Open
#2,249 0 comments 0 reactions 1 assignee Claimed by @SilinPavel View on GitHub
goal/dorado :sparkles: kind/enhancement sys/release-notes-agent
Dominant language
Java
Stars
163
Forks
65
Avg merge
11h 46m
Merged PRs (30d)
29

Description

Since we decide to implement Release Note Agent #2242 and this software relies on commit messages conventions we need to provide convenient way to remind for the developer team to commit all changes with appropriate messages.

Lets use https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks for this

The main idea is to define Pre-Commit or Pre-Push hook to be able to restrict such action if messages of this commits is not complaint with our conventions.

For now we can see the next helpful conventions:
- Each commit should have constriction that target specific issue ( [ Issue #, issue # ] )
- If You need to commit anything without specifying an issue you need to use pre-defined construction `Issue #undefined#`

**NOTE** It is also would be helpful to automatically change PR merge commits messages

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.