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

Update CHANGELOG Format and PR Title Formats #265

Open
thw26 opened this issue Jan 21, 2025 · 8 comments
Open

Update CHANGELOG Format and PR Title Formats #265

thw26 opened this issue Jan 21, 2025 · 8 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@thw26
Copy link
Collaborator

thw26 commented Jan 21, 2025

https://keepachangelog.com/en/1.0.0/

Per brief comment exhcange with @ctrlaltf24, we should look to standardize our changelog as well as the titles for PRs.

@thw26 thw26 added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 21, 2025
@thw26 thw26 added this to the Release 1.0.0 milestone Jan 21, 2025
@ctrlaltf24
Copy link
Contributor

A standard for commit message format that I normally use: https://www.conventionalcommits.org/en/v1.0.0/

@n8marti
Copy link
Collaborator

n8marti commented Jan 31, 2025

A standard for commit message format that I normally use: https://www.conventionalcommits.org/en/v1.0.0/

This looks like a nice idea, although I maybe would end up incorporating a lazy version of it. But these all look doable to me:

types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.

@n8marti
Copy link
Collaborator

n8marti commented Jan 31, 2025

https://keepachangelog.com/en/1.0.0/

Per brief comment exhcange with @ctrlaltf24, we should look to standardize our changelog as well as the titles for PRs.

This looks good to me, too, but I haven't yet been involved in updating the changelog. I guess I could start...

@n8marti
Copy link
Collaborator

n8marti commented Jan 31, 2025

We could broaden this out and include standardizing on linting? Or maybe that's already semi-official with ruff?

@n8marti
Copy link
Collaborator

n8marti commented Jan 31, 2025

Is there a PR title format suggestion already?

@ctrlaltf24
Copy link
Contributor

there a PR title format suggestion already?

Same format as commit message

@ctrlaltf24
Copy link
Contributor

We could broaden this out and include standardizing on linting? Or maybe that's already semi-official with ruff?

Created a new issue #287

@ctrlaltf24
Copy link
Contributor

incorporating a lazy version of it

Perfectly fine with this, no need to be strict but having a standard format could help our commit messages and changelog be more readable across authors. So what if we slip up a little bit, or our changelog format uses different markdown formatting. For the changelog what's important is the methodology - that this is meant for users (with links to GitHub), but is meant to be readable on its own.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants