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 Pull Request template with breaking change indication #223

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jpengar
Copy link
Collaborator

@jpengar jpengar commented Nov 5, 2024

What type of PR is this?

  • subproject management

What this PR does / why we need it:

This PR updates the PR template as done for Commonalities in camaraproject/Commonalities#314

Since some of CAMARA APIs are published as stable implementation of braking changes would require bumping up the main API version.
This should be indicated in the PR. And analyzed in its review.

Which issue(s) this PR fixes:

N/A

Special notes for reviewers:

N/A

Changelog input

 Pull Request template with breaking change indication

Additional documentation

N/A

@AxelNennker
Copy link
Collaborator

I think whether a PR introduces a breaking change might be subjective in some cases.
Who decides then whether it is a breaking change?
What are the consequences?

@rartych
Copy link
Collaborator

rartych commented Nov 5, 2024

Yes it is often a matter of opinion.
And the PRs often evolve during review.

So I think the first judgement is proposed by author of the PR and then it is verified during the review - codeowners are able to edit the starting comment

@rartych
Copy link
Collaborator

rartych commented Nov 6, 2024

It occured in Commonalities that the format of the list with checkboxes is treated by Github as a tasklist.
So PRs are listed with indication of "1 of 2 tasks" completed that can be confusing.

@AxelNennker
Copy link
Collaborator

Desided to wait for Commonalities regarding the Action Item issue.

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.

3 participants