Skip to contentSkip to conversation

README.md: document github use

PATCH In review Michael S. Tsirkin 3 participants 3 messages Jul 22, 2019 – Jul 23, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 README.md: document github use

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
README.md +28 -0
index 3de0c1e..0aceb75 100644
@@ -69,6 +69,34 @@ in <A
 HREF="https://github.com/oasis-tcs/virtio-admin">https://github.com/oasis-tcs/virtio-admin</A>.
 
 </div>
+<h4>Use of github issues</h4>
+Note: according to the virtio TC rules, all official TC communication
+is taking on one of the TC mailing lists.
+In particular, all comments must be provided on
+one of the TC mailing lists. Accordingly, the TC will not respond
+to comments provided in github issues: github issues are
+used solely to track integration of comments into the
+specification.<p>
+To request a TC vote on resolving a specific comment:
+<ol>
+<li>Create a github issue, or edit an existing issue, with
+a short summary of the comment.
+The issue MUST specify
+the link to the latest proposal in the TC mailing list
+archives. <em>Note:</em> the link MUST be in the issue description itself -
+<em>not</em> in the comments.</li>
+<li>Reply by email to the comment email, requesting that the TC vote
+on resolving the issue.
+The mail requesting the vote should include the following, on a line by itself:<br>
+<code>
+Fixes: https://github.com/oasis-tcs/virtio-spec/issues/NNN
+</code>
+(NNN is the issue number)</li>
+<li>Please make sure to allow time after a comment resolving
+an issue is posted and
+before asking for a vote.</li>
+</ol>
+
 <h3>Contact</h3>
 <p>Please send questions or comments about <a href="https://www.oasis-open.org/resources/tcadmin/github-repositories-for-oasis-tc-members-chartered-work">OASIS TC GitHub repositories</a> to <a href="mailto:[email protected]">Robin Cover</a> and <a href="mailto:[email protected]">Chet Ensign</a>.  For questions about content in this repository, please contact the TC Chair or Co-Chairs as listed on the the virtio TC's <a href="https://www.oasis-open.org/committees/virtio/">home page</a>.</p>
 </div>
Signature · 6 lines
MST

---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that 
generates this mail.  Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php 
#1 lore raw
Quoted 10 lines · On Mon, 22 Jul 2019 16:39:39 -0400 "Michael S. Tsirkin" <[email protected]> wrote:
---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
README.md +0 -0
index 3de0c1e..0aceb75 100644

README.md in <A · line 74

Quoted 6 lines
README.md +3 -0
@@ -69,6 +69,34 @@ in <A
 HREF="https://github.com/oasis-tcs/virtio-admin">https://github.com/oasis-tcs/virtio-admin</A>.
 
 </div>
+<h4>Use of github issues</h4>
+Note: according to the virtio TC rules, all official TC communication
+is taking on one of the TC mailing lists.

"is taking place" ?

Quoted 13 lines
README.md +13 -0
+In particular, all comments must be provided on
+one of the TC mailing lists. Accordingly, the TC will not respond
+to comments provided in github issues: github issues are
+used solely to track integration of comments into the
+specification.<p>
+To request a TC vote on resolving a specific comment:
+<ol>
+<li>Create a github issue, or edit an existing issue, with
+a short summary of the comment.
+The issue MUST specify
+the link to the latest proposal in the TC mailing list
+archives. <em>Note:</em> the link MUST be in the issue description itself -
+<em>not</em> in the comments.</li>

README.md in <A · line 97

Quoted 10 lines
README.md +10 -0
+<li>Reply by email to the comment email, requesting that the TC vote
+on resolving the issue.
+The mail requesting the vote should include the following, on a line by itself:<br>
+<code>
+Fixes: https://github.com/oasis-tcs/virtio-spec/issues/NNN
+</code>
+(NNN is the issue number)</li>
+<li>Please make sure to allow time after a comment resolving
+an issue is posted and
+before asking for a vote.</li>

Maybe reword as:

"Please make sure to allow some time between posting a comment resolving an issue and asking for a vote." ?

Otherwise, this looks good to me.

README.md in <A · line 102

Quoted 5 lines
README.md +2 -0
+</ol>
+
 <h3>Contact</h3>
 <p>Please send questions or comments about <a href="https://www.oasis-open.org/resources/tcadmin/github-repositories-for-oasis-tc-members-chartered-work">OASIS TC GitHub repositories</a> to <a href="mailto:[email protected]">Robin Cover</a> and <a href="mailto:[email protected]">Chet Ensign</a>.  For questions about content in this repository, please contact the TC Chair or Co-Chairs as listed on the the virtio TC's <a href="https://www.oasis-open.org/committees/virtio/">home page</a>.</p>
 </div>

---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that generates this mail. Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php

#2 lore raw
In reply to Michael S. Tsirkin
Quoted 10 lines · Michael S. Tsirkin
---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
README.md +0 -0
index 3de0c1e..0aceb75 100644

README.md in <A · line 74

Quoted 6 lines
README.md +3 -0
@@ -69,6 +69,34 @@ in <A
 HREF="https://github.com/oasis-tcs/virtio-admin">https://github.com/oasis-tcs/virtio-admin</A>.
 
 </div>
+<h4>Use of github issues</h4>
+Note: according to the virtio TC rules, all official TC communication
+is taking on one of the TC mailing lists.

s/is taking on/takes place on/

README.md in <A · line 79

Quoted 5 lines
README.md +5 -0
+In particular, all comments must be provided on
+one of the TC mailing lists. Accordingly, the TC will not respond
+to comments provided in github issues: github issues are
+used solely to track integration of comments into the
+specification.<p>

This sense can be made clearer:

"github issues are used solely to track integration of comments from the TC mailing lists into the specification"

README.md in <A · line 87

Quoted 8 lines
README.md +8 -0
+To request a TC vote on resolving a specific comment:
+<ol>
+<li>Create a github issue, or edit an existing issue, with
+a short summary of the comment.
+The issue MUST specify
+the link to the latest proposal in the TC mailing list
+archives. <em>Note:</em> the link MUST be in the issue description itself -
+<em>not</em> in the comments.</li>

I don't understand what this note means.

README.md in <A · line 95

Quoted 8 lines
README.md +8 -0
+<li>Reply by email to the comment email, requesting that the TC vote
+on resolving the issue.
+The mail requesting the vote should include the following, on a line by itself:<br>
+<code>
+Fixes: https://github.com/oasis-tcs/virtio-spec/issues/NNN
+</code>
+(NNN is the issue number)</li>
+<li>Please make sure to allow time after a comment resolving

Clarification:

"Please make sure to allow time for review after a comment resolving ..."