Skip to content

Commit

Permalink
Add impacts on implementors to the definition of breaking changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jascha Franklin-Hodge authored and hunterowens committed Apr 9, 2019
1 parent ffffed0 commit d399ee7
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request---proposal.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate
A clear and concise description of what you want to happen.

**Is this a breaking change**
A breaking change would require consumers of the API to modify their code for it to continue to function (ex: renaming of a required field or the change in data type of an existing field). A non-breaking change would allow existing code to continue to function (ex: addition of an optional field or the creation of a new optional endpoint).
A breaking change would require consumers or implementors of the API to modify their code for it to continue to function (ex: renaming of a required field or the change in data type of an existing field). A non-breaking change would allow existing code to continue to function (ex: addition of an optional field or the creation of a new optional endpoint).

[ ] Yes, breaking
[ ] No, not breaking
Expand Down
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Please provide a clear and concise reason for this pull request and the impact of the change

**Is this a breaking change**
A breaking change would require consumers of the API to modify their code for it to continue to function (ex: renaming of a required field or the change in data type of an existing field). A non-breaking change would allow existing code to continue to function (ex: addition of an optional field or the creation of a new optional endpoint).
A breaking change would require consumers or implementors of the API to modify their code for it to continue to function (ex: renaming of a required field or the change in data type of an existing field). A non-breaking change would allow existing code to continue to function (ex: addition of an optional field or the creation of a new optional endpoint).

[ ] Yes, breaking
[ ] No, not breaking
Expand Down

0 comments on commit d399ee7

Please sign in to comment.