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

Add section for breaking changes to pull request template #344

Merged

Conversation

andregasser
Copy link
Owner

Description

I have added a section for listing breaking changes that have been introduced as part of a pull request.

Type of Change

  • Documentation only

How Has This Been Tested?

No tests executed - documentation only.

Mandatory Checklist

  • My change follows the projects coding style
  • I ran gradle check and there were no errors reported
  • I have performed a self-review of my code
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • KDoc added to all public methods

Optional Things To Check

The items below are some more things to check before asking other people to review your code.

  • In case you worked on new features: Did you also implement the reactive endpoint (bigbone-rx)?
  • In case you added new *Methods classes: Did you also add it to MastodonClient?
  • In case you worked on endpoints: Please mention in the PR that API Coverage page needs to be updated (if needed)

Copy link
Collaborator

@PattaFeuFeu PattaFeuFeu left a comment

Choose a reason for hiding this comment

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

Good change 👍

Optional improvement: Should we remove the “Breaking change” item in “Type of change”? Otherwise, there’ll just be duplicate information in here.

Copy link

codecov bot commented Nov 15, 2023

Codecov Report

Merging #344 (0cac5e6) into master (6cffd23) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff            @@
##             master     #344   +/-   ##
=========================================
  Coverage     46.30%   46.30%           
  Complexity      485      485           
=========================================
  Files           129      129           
  Lines          3542     3542           
  Branches        233      233           
=========================================
  Hits           1640     1640           
  Misses         1727     1727           
  Partials        175      175           

Removed "Breaking change" as a change type, added better explanation on
what a breaking change is.
@andregasser
Copy link
Owner Author

Good change 👍

Optional improvement: Should we remove the “Breaking change” item in “Type of change”? Otherwise, there’ll just be duplicate information in here.

Good idea! I have updated the template. Also added a better explanation on what we consider a breaking change (taken from the Google OSS Library Breaking Change Policy guide).

@PattaFeuFeu PattaFeuFeu merged commit 1e9af35 into master Nov 15, 2023
5 checks passed
@PattaFeuFeu PattaFeuFeu deleted the pull-request-template-add-breaking-changes-section branch November 15, 2023 15:38
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