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

Add commit linting to allow for the generation of a more human-readable changelog for releases #106

Closed
jpower432 opened this issue Dec 8, 2023 · 0 comments · Fixed by #297
Assignees
Labels
maintenance Maintenance tasks and refactors

Comments

@jpower432
Copy link
Contributor

Is your feature request related to a problem? Please describe.

Inconsistency in the commit history can make it difficult to understand what has changed between releases.

Describe the solution you'd like

  • Choose a standard way of structuring commits/changes that is supported by existing changelog generation tools (e.g, conventional commit, gitmoji, labels)
  • Add it to the .pre-commit-config.yaml
  • Update the documentation for contributing

Additional context

@jpower432 jpower432 added the maintenance Maintenance tasks and refactors label Feb 22, 2024
@jpower432 jpower432 self-assigned this Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Maintenance tasks and refactors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant