The SACM working group uses GitHub to track issues against draft documents. Authors/editors are encouraged to also use GitHub to store drafts-in-progress. As of March 2015 we are just getting started with GitHub, so things may change over time. What you'll find here is general guidance on how we expect to use GitHub to our advantage.
We've been able to set up GitHub email notifications so that they are set to sacm@…. Issues and discussions about those issues should happen in GitHub, and they will be sent to sacm@….
To get started using Git Hub for SACM:
There you'll find several repositories, each relating to one or more of our WG drafts. It's recommended that you subscribe or "watch" the repositories as your interest level dictates. Keep in mind that everything will be sent to the sacm@… mailing list, but you won't be able to reply to GitHub-originated e-mails using the SACM list. If you want to do that, you should subscribe to the repositories and/or watch the issues in which you have an interest.
TBD
To create an issue, ensure you're logged in to GitHub then:
This is open-ended, but try to be as descriptive as possible with your title while not being verbose. A title like "Typo" is unhelpful compared to a title like "An ABNF typo exists in section 5". The idea is to provide enough (but just enough) information to let a reader know what's wrong.
As an editor/author of a given draft, you will need to be associated with the SACMWG organization (to become associated with the SACMWG organization, contact the WG chairs and provide your GitHub user name). An issue handler will need to:
An issue can be categorized using labels, and these labels are intended to change as an issue moves through the workflow. The issues we've talked about using on the list can be split into "submission labels" and "handling labels".
Submission Labels:
Handling Labels:
Version Labels:
TBD.
The content of this page was last updated on 2016-04-30. It was migrated from the old Trac wiki on 2023-01-30.