Rule-issue-templates

[daniel-montalvo]

Proposes to add issue templates for composite and atomic rules, and to change to new GH issue template config Closes issue(s):

• none

Need for Call for Review: other: Issue templates This will require a 1 week Call for Review

---

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.

[WilcoFiers]

@daniel-montalvo I guess I'm just not sure what you're hoping to get from this. We don't write rules in issues. We use pull requests for that. Why would rule templates need to be available as templates for issues?

[daniel-montalvo]

I thought rough concept draft rules were first put in issues and, if consensus exists that these should be worked on, they’d be move to a PR for further refinement.

Then this does not seem to make much sense.

Best.

---

Daniel Montalvo

Accessibility Harmonization and Training Specialist

W3C/WAI

From: Wilco Fiers @.> Sent: Thursday, June 15, 2023 2:34 PM To: act-rules/act-rules.github.io @.> Cc: Daniel Montalvo @.>; Mention @.> Subject: Re: [act-rules/act-rules.github.io] Rule-issue-templates (PR #2072)

@daniel-montalvo https://github.com/daniel-montalvo I guess I'm just not sure what you're hoping to get from this. We don't write rules in issues. We use pull requests for that. Why would rule templates need to be available as templates for issues?

— Reply to this email directly, view it on GitHub https://github.com/act-rules/act-rules.github.io/pull/2072#issuecomment-1592961080 , or unsubscribe https://github.com/notifications/unsubscribe-auth/ALYFOWQU2IO5WH75WTF5N6TXLL6MZANCNFSM6AAAAAAY4U3TVU . You are receiving this because you were mentioned.Message ID: @.***>

[Jym77]

I agree that issues are not a good place to discuss fully written rules (i.e. using the full template) because they don't make it possible to comment on specific bits as PR review do, and as we do on every single rule proposed.

Thus said:

• The current template seems unclear about that and seems to push people toward *issue rather than PR to author new rules. Maybe we should update it to say something like "if authoring a new rule, open a PR with the good template".
• For not fully fleshed out ideas, we may want a simplified template like "Applicability/Expectation/mapping/some explanation why this rule is good" which is enough to discuss the rule before writing it (and we often have these simplified Applicability/Expectation description in discussions). Maybe we could have that as a "rule idea template" or something 🤔
• All up for switching to the new template config 😄