microsoft / microsoft/gctoolkit

Consider checking for keywords in commit messages to align with JReleaser syntax for Release notes

Open
#244 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
1.3k
Forks
177
Avg merge
1d 11h
Merged PRs (30d)
3

Description

JReleaser follows an open std on parsing commit messages for keywords that it uses to nicely produce release notes. Consider enforcing this vi a GHAction that checks messages.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or workflow entry points are named in the issue. Start by reviewing the repository's existing GitHub Actions and JReleaser-related release configuration, then determine how commit-message keywords should be checked. Done means the agreed syntax is enforced automatically and invalid messages are reported clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.