Skip to content

Clarify how to write a commit message and CHANGELOGs #14830

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

Merged
merged 1 commit into from
Jan 15, 2021

Conversation

fabpot
Copy link
Member

@fabpot fabpot commented Jan 14, 2021

No description provided.

@carsonbot carsonbot added this to the 4.4 milestone Jan 14, 2021
@OskarStark
Copy link
Contributor

@Nyholm do you think this can be achieved by fabbot? Otherwise I am afraid, we cannot think of it all the time

@fabpot
Copy link
Member Author

fabpot commented Jan 14, 2021

I'm the one managing fabbot :)

@OskarStark
Copy link
Contributor

I'm the one managing fabbot :)

Indeed, he is actively working on gh and carsonbot 😃

fabpot added a commit to symfony/symfony that referenced this pull request Jan 14, 2021
This PR was merged into the 5.3-dev branch.

Discussion
----------

No patch version in CHANGELOG

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | ---
| License       | MIT
| Doc PR        | ---

Based on symfony/symfony-docs#14830

cc @fabpot, feel free to close, as we discussed this already via Slack

Commits
-------

575d9b0 No patch version in CHANGELOG
@dunglas
Copy link
Member

dunglas commented Jan 14, 2021

Regarding commit messages, are you aware of the conventional commits spec? It has a nice syntax and some tools already implement it (GitHub bots checking message formats, changelog generators, linters, IDE plugins etc).

For Symfony commit messages following this spec would look like:

feat(serializer): add support for foo
fix(dependency-injection): add missing type hint for bar
fix(cache)!: remove function foo()

BREAKING CHANGE: function foo() has been removed to fix a security issue

@fabpot
Copy link
Member Author

fabpot commented Jan 14, 2021

TBH, that's looks really ugly :) And we already have tools built around our conventions.

symfony-splitter pushed a commit to symfony/notifier that referenced this pull request Jan 14, 2021
This PR was merged into the 5.3-dev branch.

Discussion
----------

No patch version in CHANGELOG

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | ---
| License       | MIT
| Doc PR        | ---

Based on symfony/symfony-docs#14830

cc @fabpot, feel free to close, as we discussed this already via Slack

Commits
-------

575d9b04b4 No patch version in CHANGELOG
symfony-splitter pushed a commit to symfony/mattermost-notifier that referenced this pull request Jan 15, 2021
This PR was merged into the 5.3-dev branch.

Discussion
----------

No patch version in CHANGELOG

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | ---
| License       | MIT
| Doc PR        | ---

Based on symfony/symfony-docs#14830

cc @fabpot, feel free to close, as we discussed this already via Slack

Commits
-------

575d9b04b4 No patch version in CHANGELOG
symfony-splitter pushed a commit to symfony/slack-notifier that referenced this pull request Jan 15, 2021
This PR was merged into the 5.3-dev branch.

Discussion
----------

No patch version in CHANGELOG

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | ---
| License       | MIT
| Doc PR        | ---

Based on symfony/symfony-docs#14830

cc @fabpot, feel free to close, as we discussed this already via Slack

Commits
-------

575d9b04b4 No patch version in CHANGELOG
symfony-splitter pushed a commit to symfony/linked-in-notifier that referenced this pull request Jan 15, 2021
This PR was merged into the 5.3-dev branch.

Discussion
----------

No patch version in CHANGELOG

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | ---
| License       | MIT
| Doc PR        | ---

Based on symfony/symfony-docs#14830

cc @fabpot, feel free to close, as we discussed this already via Slack

Commits
-------

575d9b04b4 No patch version in CHANGELOG
symfony-splitter pushed a commit to symfony/esendex-notifier that referenced this pull request Jan 15, 2021
This PR was merged into the 5.3-dev branch.

Discussion
----------

No patch version in CHANGELOG

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | ---
| License       | MIT
| Doc PR        | ---

Based on symfony/symfony-docs#14830

cc @fabpot, feel free to close, as we discussed this already via Slack

Commits
-------

575d9b04b4 No patch version in CHANGELOG
symfony-splitter pushed a commit to symfony/zulip-notifier that referenced this pull request Jan 15, 2021
This PR was merged into the 5.3-dev branch.

Discussion
----------

No patch version in CHANGELOG

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | ---
| License       | MIT
| Doc PR        | ---

Based on symfony/symfony-docs#14830

cc @fabpot, feel free to close, as we discussed this already via Slack

Commits
-------

575d9b04b4 No patch version in CHANGELOG
@javiereguiluz
Copy link
Member

Thank you Fabien.

@javiereguiluz javiereguiluz merged commit 09b30d5 into symfony:4.4 Jan 15, 2021
fabpot added a commit to symfony/symfony that referenced this pull request Feb 5, 2021
This PR was submitted for the 5.x branch but it was merged into the 4.4 branch instead.

Discussion
----------

Update PULL_REQUEST_TEMPLATE.md

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | See #40097 (comment)
| License       | MIT
| Doc PR        | Doc introduced in symfony/symfony-docs#14830

ping @OskarStark do you think this can be valuable here? as this file is the entry point of all PRs

Commits
-------

41c7796 Update PULL_REQUEST_TEMPLATE.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants