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

COSMETIC: Attributes: Clarify attribute spec on several key points, and align it with the implementation definitions #12

Merged
merged 6 commits into from
Dec 9, 2022

Conversation

bleggett
Copy link
Contributor

@bleggett bleggett commented Dec 6, 2022


Proposed Changes

  • More completely and exhaustively define "what an attribute is", using the descriptors we actually use in OpenTDF, and explicitly state important implications of the definitions.

Checklist

  • A clear description of the change has been included in this PR.
  • A clear description of whether this change is a Major, Minor, Patch or cosmetic change as per the Versioning Guidelines has been included in this PR.
  • All schema validation tests have been updated appropriately and are passing.
  • MAJOR/MINOR VERSION CHANGES ONLY: This PR should be made in branches prefixed with draft-<change>
  • MAJOR/MINOR VERSION CHANGES ONLY: A link to a reference implementation (PR or set of PRs) of the change has been included in this PR.
  • MAJOR/MINOR VERSION CHANGES ONLY: A writeup has been included discussing the motivation and impact of this change.
  • MAJOR/MINOR VERSION CHANGES ONLY: The minimum wait time has elapsed.
  • DRAFT MERGE ONLY: Draft Semver has been updated in the VERSION file (optional)
  • DRAFT MERGE ONLY: Tagged this branch with new semver version and an annotation describing the change (ex: git tag -s 4.1.0 -m "Spec version 4.1.0 - did a thing")
  • DRAFT MERGE ONLY: Version numbers have been updated as per the Versioning Guidelines.
  • This change otherwise adheres to the project Contribution Guidelines.

@bleggett bleggett requested a review from a team as a code owner December 6, 2022 16:54
@bleggett bleggett changed the title Align the spec with the implementation definitions Attributes: Clarify attribute spec on several key points, and align it with the implementation definitions Dec 6, 2022
@bleggett bleggett changed the title Attributes: Clarify attribute spec on several key points, and align it with the implementation definitions PATCH: Attributes: Clarify attribute spec on several key points, and align it with the implementation definitions Dec 6, 2022
@bleggett bleggett added documentation Improvements or additions to documentation draft-semver-change:cosmetic labels Dec 6, 2022
@bleggett bleggett changed the title PATCH: Attributes: Clarify attribute spec on several key points, and align it with the implementation definitions COSMETIC: Attributes: Clarify attribute spec on several key points, and align it with the implementation definitions Dec 6, 2022
Copy link

@stephaniegraham stephaniegraham left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for responding to my nit-picks!

@stephaniegraham stephaniegraham merged commit 4a4215a into main Dec 9, 2022
@stephaniegraham stephaniegraham deleted the align-attribute-doc branch December 9, 2022 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation draft-semver-change:cosmetic
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants