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

chore: add a pull request template #412

Merged

Conversation

vvatanabe
Copy link
Collaborator

@sashabaranov I've created a pull request template for bug reports. Could you please review the content of the template?

@codecov
Copy link

codecov bot commented Jun 26, 2023

Codecov Report

Merging #412 (50faedf) into master (581f70b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #412   +/-   ##
=======================================
  Coverage   96.95%   96.95%           
=======================================
  Files          17       17           
  Lines         690      690           
=======================================
  Hits          669      669           
  Misses         15       15           
  Partials        6        6           

@vvatanabe
Copy link
Collaborator Author

vvatanabe commented Jun 27, 2023

@sashabaranov
How about prefixing the title of pull requests that contain breaking changes with [BREAKING_CHANGES]? This would make it immediately clear on the release page under the 'What's Changed' section that a breaking change has been introduced. (I presume the release page is auto-generated by a tool, right?) This approach is very developer-friendly. If there are no objections, I want to incorporate that rule into this pull request template.


Here's an example (Note that no actual changes have been made).

image

Copy link
Owner

@sashabaranov sashabaranov left a comment

Choose a reason for hiding this comment

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

Thank you so much! I agree with the [BREAKING_CHANGES] suggestion, it would definitely help!

@sashabaranov sashabaranov merged commit 86d0f48 into sashabaranov:master Jun 28, 2023
3 checks passed
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.

2 participants