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.

Sign up for GitHub

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

Jump to bottom

[TASK] Update documentation to reflect process for breaking changes and deprecations #54

Closed
Tracked by #55
shurwit opened this issue May 2, 2022 · 0 comments · Fixed by #56
Closed
Tracked by #55

[TASK] Update documentation to reflect process for breaking changes and deprecations #54

shurwit opened this issue May 2, 2022 · 0 comments · Fixed by #56
Assignees
@shurwit
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
v1.1.0

Comments

@shurwit
Copy link
Collaborator

shurwit commented May 2, 2022 •
edited

Description

We need a process to alert consumers of this library when breaking changes or deprecations occur, and to explain what changes will need to be made to upgrade to the latest version. This process should be documented as a reference for contributors to this project.

Acceptance Criteria

A CONVENTIONS.md file should be added and updated to explain the intended process for breaking changes and deprecations
@shurwit shurwit added documentation Improvements or additions to documentation enhancement New feature or request labels May 2, 2022
@shurwit shurwit self-assigned this May 2, 2022
@shurwit shurwit added this to the v1.1.0 milestone May 4, 2022
@shurwit shurwit mentioned this issue May 4, 2022
Closed
6 tasks
@shurwit shurwit changed the title [TASK] Update documentation to reflect process for breaking changes [TASK] Update documentation to reflect process for breaking changes and deprecations May 16, 2022
@shurwit shurwit mentioned this issue May 16, 2022
Merged
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shurwit shurwit

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
v1.1.0
1 participant
@shurwit