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

docs(contributing): describe using conventional commits #877

Merged
merged 3 commits into from
Sep 12, 2024
Merged

Conversation

calmh
Copy link
Member

@calmh calmh commented Sep 10, 2024

Policy change.

@calmh calmh marked this pull request as draft September 10, 2024 12:46
@calmh calmh marked this pull request as ready for review September 10, 2024 12:46
@calmh calmh changed the title docs(contributing): describe using conventional commits docasdasds(contributing): describe using conventional commits Sep 10, 2024
@calmh calmh changed the title docasdasds(contributing): describe using conventional commits docs(contributing): describe using conventional commits Sep 10, 2024
dev/contributing.rst Outdated Show resolved Hide resolved
dev/contributing.rst Outdated Show resolved Hide resolved

- Commits that resolve an existing issue must include the issue number
as ``(fixes #123)`` at the end of the commit message subject. A correctly
formatted commit message looks like this::

lib/dialer: Add env var to disable proxy fallback (fixes #3006)
feat(dialer): add env var to disable proxy fallback (fixes #3006)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thought we wanted to move the "fixes" mention from the subject to the message body?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do, in principle, but there was some pushback and we have some scripts that expect it, so I think it can stay for now.

Co-authored-by: André Colomb <[email protected]>
@calmh calmh merged commit df49711 into main Sep 12, 2024
3 checks passed
@calmh calmh deleted the jb/convcommits branch September 12, 2024 07:48
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.

4 participants