Skip to content

Commit

Permalink
The GitHub template should address wide review
Browse files Browse the repository at this point in the history
  • Loading branch information
plehegar committed Jul 1, 2021
1 parent 9e444fc commit d2b3c29
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 16 deletions.
14 changes: 9 additions & 5 deletions createGitHubIssue.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function createGitHubIssue() {
return;
}

const title = encodeURIComponent('Seek horizontal reviews');
const title = encodeURIComponent('Seek wide review');
const body = encodeURIComponent(generateGitHubIssueBody());
window.open(`https://github.com/${repo}/issues/new?title=${title}&body=${body}`);
}
Expand All @@ -36,14 +36,18 @@ function generateGitHubIssueBody() {
return;
}

const subContents = [...dd.querySelectorAll('.step')].map(el => ` - [ ] ${el.innerHTML}`);
const subContents = [...dd.querySelectorAll('.step')].map(el => ` - [ ] ${el.innerHTML}`);

return `- ${dt.textContent}\n${subContents.join('\n')}`;
return ` - ${dt.textContent}\n${subContents.join('\n')}`;
});

return `This is a meta issue to track horizontal review steps for the specification.
See [How to do wide review](https://www.w3.org/Guide/documentreview/#how_to_get_horizontal_review) for details.
return `This is a meta issue to track wide review steps for the specification.
See [How to do wide review](https://www.w3.org/Guide/documentreview/#who_to_ask_for_review) for details.
- [ ] the groups listed in the WG's charter, especially those who manage dependencies
- [ ] the groups jointly responsible for a particular document (if any).
- the horizontal groups:
${bullets.join('\n')}
- Other outreach (if applicable)
`;
}
23 changes: 12 additions & 11 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,23 @@ <h2>Who to ask for wide review?</h2>

</ul>

<aside id='using_github_issue'>
<p><strong>Tip:</strong> consider tracking your wide review progress using a
GitHub issue, such as <a href="https://github.com/w3c/sensors/issues/299">issue
#299 of the Sensors API</a>. You can then simply point the Director to the
issue.</p>

<details id="githubissue" hidden>
<summary>Generate a meta-issue to track wide review steps in a GitHub repository</summary>
<p>You may find it useful to create an issue in the GitHub repository of your spec to track your progress. Add the name of your GitHub repository to the field below and hit the "Create GitHub issue" button. This opens the "new issue" form in your repository, and pre-fills the body with review steps as a list of checkboxes.</p>
<p>
<label for="repository">GitHub repository where issue should be created (format: <code>owner/repo</code>):</label>
<br/><input type="text" name="repository" id="repository" placeholder="Repo name, e.g. w3c/documentreview">
<br/><button>Create GitHub issue</button>
</p>
<p>Note: You will be able to edit the issue's title and body before it gets created.</p>
</details>
</aside>

<p>The reviews provided by the <a
href="https://www.w3.org/Guide/process/charter.html#horizontal-review">horizontal
Expand Down Expand Up @@ -214,17 +226,6 @@ <h2>How to get horizontal review</h2>
</dd>
</dl>

<details id="githubissue" hidden>
<summary>Generate a meta-issue to track horizontal review steps in a GitHub repository</summary>
<p>You may find it useful to create an issue in the GitHub repository of your spec to track your progress. Add the name of your GitHub repository to the field below and hit the "Create GitHub issue" button. This opens the "new issue" form in your repository, and pre-fills the body with horizontal review steps as a list of checkboxes.</p>
<p>
<label for="repository">GitHub repository where issue should be created (format: <code>owner/repo</code>):</label>
<br/><input type="text" name="repository" id="repository" placeholder="Repo name, e.g. w3c/documentreview">
<br/><button>Create GitHub issue</button>
</p>
<p>Note: You will be able to edit the issue's title and body before it gets created.</p>
</details>

<p>You should familiarize yourself with the rest of this document. This section is just a quick reminder for when you are in the middle of doing the work.</p>
<p>Recognize that horizontal review groups may be resource limited and may only be able to do one review or may have difficulty scheduling your review quickly. Give them as much time as you can, consistent with asking for review while it is still reasonable to change the technology to accommodate the issues they find.</p>
</section>
Expand Down

0 comments on commit d2b3c29

Please sign in to comment.