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

Readme should document expectations of for New PR template and New Issue template (order, optionality, etc.) #1861

Closed
cookiecrook opened this issue Jan 26, 2023 · 5 comments · Fixed by #1872
Labels
editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo

Comments

@cookiecrook
Copy link
Contributor

The New Issue and New PR templates are a great addition, but the expectations should be documented in the Readme or elsewhere. For example, which aspects are non-optional, and in what order should they be completed? e.g. It would be bad to file/fix an engine bug tracker if the related ARIA PR was rejected, so when should this happen?

As an example, I left some relevant items blank in the template for PR #1860 b/c I think there is an appropriate order to completing them. I'll add a starting point below as a second comment. Please feel free to edit it.

@cookiecrook cookiecrook added the editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo label Jan 26, 2023
@cookiecrook
Copy link
Contributor Author

cookiecrook commented Jan 26, 2023

I thought the blank items in PR #1860 should probably be added in sequence. For example:

  1. Discuss Issue and Review Spec PR
  2. Add the related AccName tracker once Spec PR review approved?
  3. Add the APG tracker, but don’t complete it until after implementations update.
  4. Merge Spec and AccName PRs simultaneously?
  5. Parallel tasks following merge?
    • Add web engine implementation trackers.
    • Add WPT trackers, tests, or both?
    • Add validator tracker?
  6. Complete APG issue?

@cookiecrook cookiecrook changed the title Readme should document expectations of new Issue and PR templates Readme should document expectations of templates for New Issues and New PRs (order, optionality, etc.) Jan 26, 2023
@cookiecrook cookiecrook changed the title Readme should document expectations of templates for New Issues and New PRs (order, optionality, etc.) Readme should document expectations of for New PR template and New Issue template (order, optionality, etc.) Jan 26, 2023
@spectranaut
Copy link
Contributor

I think you mean:

  1. Discuss/review Issue

@cookiecrook
Copy link
Contributor Author

  1. Discuss/review Issue

"Discuss Issue and Review Spec PR"

In the example used, #1860 we already have a PR, but I am not sure the Engine Implementation bugs should be filed until the WG approves of the proposed change.

@spectranaut
Copy link
Contributor

I believe at the last couple process discussions, we decided that implementations should happen before the change lands. This follows more in the lines of a TC39/ECMAScript proposal, which have to have implementations in order to merge the proposal into the specification. During implementation, there might be feedback or changes that need to be made to the specification. Personally, I have had feedback during implementation of ARIA change.

I'd like to consider any normative PR is a "feature proposal", and a requirement be at least one (or should we say two?) implementations in a browser and implementation commitments from the remaining browsers before we merge. This will make ARIA more of an evergreen spec, and more accurately represent what is actually implemented, which we might like to move to in the future.

@spectranaut
Copy link
Contributor

spectranaut commented Feb 9, 2023

Also, a lot of this process is already documented here: https://github.com/w3c/aria/wiki/ARIA-WG-Process-Document

But I can update it based on this discussion, and also add a link in the README

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants