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

Turn "visible" examples into a rule #2087

Draft
wants to merge 9 commits into
base: develop
Choose a base branch
from
Draft

Conversation

Jym77
Copy link
Collaborator

@Jym77 Jym77 commented Jul 14, 2023

As per CG discussion, trying to turn definition's examples into a "rule" to see if we can benefit from the existing machinery to provide these in a testable way to tool implementers.
This is meant as a convenience for tool implementers, not to test any sort of requirements.

We will still need to add a bit of machinery to correctly export these test cases. We want them separated from the actual test cases of actual rules, so that testing them is purely opt-in from implementers.

Closes issue(s):

Need for Call for Review:
This will require a 2 weeks Call for Review (new process)


Pull Request Etiquette

When creating PR:

  • Make sure you're requesting to pull a branch (right side) to the develop branch (left side).
  • Make sure you do not remove the "How to Review and Approve" section in your pull request description

After creating PR:

  • Add yourself (and co-authors) as "Assignees" for PR.
  • Add label to indicate if it's a Rule, Definition or Chore.
  • Link the PR to any issue it solves. This will be done automatically by referencing the issue at the top of this comment in the indicated place.
  • Optionally request feedback from anyone in particular by assigning them as "Reviewers".

When merging a PR:

  • Close any issue that the PR resolves. This will happen automatically upon merging if the PR was correctly linked to the issue, e.g. by referencing the issue at the top of this comment.

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 Call for Review period. In case of disagreement, the longer period wins.

@Jym77 Jym77 self-assigned this Jul 14, 2023
@Jym77 Jym77 changed the title Turn visible examples into a rule Turn "visible" examples into a rule Jul 14, 2023
@tbostic32 tbostic32 self-requested a review November 30, 2023 02:03
Copy link
Member

@carlosapaduarte carlosapaduarte left a comment

Choose a reason for hiding this comment

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

Looking really good

pages/examples/target-is-visible-exuqdg.md Outdated Show resolved Hide resolved
@carlosapaduarte
Copy link
Member

And the visible definition will also have to be edited, because it links to the examples. It should link to the new "rule" instead.

@Jym77
Copy link
Collaborator Author

Jym77 commented Jan 25, 2024

And the visible definition will also have to be edited, because it links to the examples. It should link to the new "rule" instead.

Yes. Not sure what URL the new "rule" would have, though 😅

@Jym77 Jym77 requested a review from carlosapaduarte January 25, 2024 13:36
@Jym77 Jym77 removed the Agenda item label Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants