Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor to have a public message format function #173

Merged
merged 9 commits into from
Dec 5, 2024

Conversation

rkotze
Copy link
Owner

@rkotze rkotze commented Nov 19, 2024

Refactor description

Public API for git mob core will have a message formatter function to handle co-author trailers only. This should be used in consuming apps to format git message co-author trailers like Git Mob VS Code.

This has been built for extension in mind at a later point to support multiple trailers.

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Updated the CHANGELOG.md to capture my changes
  • Build (npm run build) was successfully run locally
  • All tests and linting (npm run checks) has passed locally
  • I kept my pull requests small so it can be reviewed easier

Pull request type

Please check the type of change your PR introduces:

  • Refactor

Does this introduce a breaking change?

  • No

One function to format the git message and will be a public function in git mob core.
Integrate into append message function is the main usage.
The message formatter now supports the signed off by trailer.

#121
@rkotze rkotze self-assigned this Nov 19, 2024
Need more thought on the approach to support multiple author trailers.
Update change log and readme about one message format function.
@rkotze rkotze changed the title Refactor message format and include multiple trailers Refactor to have a public message format function Dec 5, 2024
@rkotze rkotze marked this pull request as ready for review December 5, 2024 17:14
@rkotze rkotze merged commit adc5086 into master Dec 5, 2024
4 checks passed
@rkotze rkotze deleted the refactor-message-format branch December 5, 2024 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant