-
Notifications
You must be signed in to change notification settings - Fork 231
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
Rename publish_date to published_date for a geography object #597
Conversation
A policy object contains a property published_date which is the exact same thing as a geography object's publish_date. These should therefore also have the same name to prevent errors and confusion.
@schnuerle I have limited knownledge to the structure/branches of this project, I just followed the instructions and edited the dev branch. If you feel this change could be in 1.1.0, I'm happy to make another PR, but the I need to know where to put it? I saw no branch targeting 1.1.0 |
That way this PR is not breaking and be included in 1.1.0. Can be changed in next major release.
Thanks for signing. There is no branch for releases until the OMF makes a release candidate. Everything pretty much gets pointed to 'dev' like you have done already, before going to OMF tech council and board for release approval. The Milestone tags help categorize features and PRs for releases until they are ready. So you are doing things right! This whole PR can go into 1.1.0, except for the geography field name change within policy, per our conversation here, since that would be breaking. So I went in and edited that away for now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good for 1.1.0 changes to the new geography endpoint.
A policy object contains a property published_date which is the exact
same thing as a geography object's publish_date. These should therefore
also have the same name to prevent errors and confusion.
name: Default
about: Suggest changes to MDS
title: Rename publish_date to published_date for a geography object
MDS Pull Request
Thank you for your contribution! Please review our OMF contributing page to understand guidelines and policies for participation, and our Code of Conduct page.
To avoid complications and help make the Review process as smooth as possible, make sure to:
dev
branch. Please ensure you are targetingdev
, notmain
.Explain pull request
A policy object contains a property published_date which is the exact
same thing as a geography object's publish_date. These should therefore
also have the same name to prevent errors and confusion.
Is this a breaking change
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).
Impacted Spec
Which spec(s) will this pull request impact?
policy
Additional context