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

Release notes? Upgrades? Changes? Out of date documentation #553

Closed
DonThompson opened this issue Jan 26, 2021 · 1 comment · Fixed by #554
Closed

Release notes? Upgrades? Changes? Out of date documentation #553

DonThompson opened this issue Jan 26, 2021 · 1 comment · Fixed by #554
Labels
status: waiting for feedback waiting for feedback from the submitter type: docs update documentation change not affecting the code

Comments

@DonThompson
Copy link

Your Upgrades.md (in the root) states:
https://github.com/twilio/twilio-csharp/blob/main/UPGRADE.md

"After 5.0.0 all MINOR and MAJOR version bumps will have upgrade notes posted here."

However, this file has not been updated since 2017. Looks like maybe changes.md has taken over?
https://github.com/twilio/twilio-csharp/blob/main/CHANGES.md

Maybe these should be combined?

@JenniferMah
Copy link
Contributor

Hi @DonThompson,
We use the Upgrades.md to help document the changes for major version rolls of the library while the Changes.md is used to document changes to the library itself. Since these serve two different purposes we will continue to keep these seprated. You are correct that "After 5.0.0 all MINOR and MAJOR version bumps will have upgrade notes posted here." is an inaccurate message. I will go ahead and submit a PR to clarify what the upgrade guide should document to clear up any confusion.

@JenniferMah JenniferMah added status: waiting for feedback waiting for feedback from the submitter type: docs update documentation change not affecting the code labels Jan 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting for feedback waiting for feedback from the submitter type: docs update documentation change not affecting the code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants