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

Metadata in glossary #1085

Merged
merged 9 commits into from
Jan 28, 2020
Merged

Metadata in glossary #1085

merged 9 commits into from
Jan 28, 2020

Conversation

Jym77
Copy link
Collaborator

@Jym77 Jym77 commented Dec 17, 2019

Add "unambiguous" and "objective" metadata in each definition.
Co-authored by @JKODU

Closes issue(s):

Need for Final Call:
This will not require a Final Call (internal metadata with no external visibility).


Pull Request Etiquette

When creating PR:

  • Make sure you requesting to pull a branch (right side) to the develop branch (left side).

After creating PR:

  • Add yourself (and co-authors) as "Assignees" for PR.
  • Add label to indicate if it's a Rule, Definition or Chore.
  • Close the issue that the PR resolves (and make sure the issue is referenced in the top of this comment)
  • Optionally request feedback from anyone in particular by assigning them as "Reviewers".

How to Review And Approve

  • Go to the “Files changed” tab
  • Here you will have the option to leave comments on different lines.
  • Once the review is completed, find the “Review changes” button in the top right, select “Approve” (if you are really confident in the rule) or "Request changes" and click “Submit review”.
  • Make sure to also review the proposed Final Call period. In case of disagreement, the longer period wins.

@Jym77 Jym77 added Definition Editorial For editorial changes that does not change the meaning of a rule or Glossary term labels Dec 17, 2019
pages/glossary/accessible-name.md Show resolved Hide resolved
pages/glossary/decorative.md Outdated Show resolved Hide resolved
@jeeyyy
Copy link
Collaborator

jeeyyy commented Dec 17, 2019

@WilcoFiers @Jym77

Are we supposed to be using these attributes to be shown somewhere on the website?

@Jym77
Copy link
Collaborator Author

Jym77 commented Dec 18, 2019

@WilcoFiers @Jym77

Are we supposed to be using these attributes to be shown somewhere on the website?

As far as I understand, "not now".

Currently, we just add them and hope that rule authors/reviewers will think about them.
Later, we may want to add some tests.

Copy link
Member

@WilcoFiers WilcoFiers left a comment

Choose a reason for hiding this comment

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

Couple of ones I disagree with.

pages/glossary/decorative.md Outdated Show resolved Hide resolved
pages/glossary/section-of-content.md Outdated Show resolved Hide resolved
EmmaJP
EmmaJP previously requested changes Jan 8, 2020
Copy link
Collaborator

@EmmaJP EmmaJP left a comment

Choose a reason for hiding this comment

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

Mostly seems fine. Agree with most of Wilco's comments and added one or two of my own.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Definition Editorial For editorial changes that does not change the meaning of a rule or Glossary term reviewers wanted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants