In order to do this, you'll need to know the following info:
- A title for the proposal or work item.
- A shortname for the proposal or work item. This will be used for the repository name, as well as the shortname in Bikeshed (for work items).
- A short description of the proposal or work item.
- The GitHub usernames of the folks making the proposal or the editors of the work item.
- If this is a work item, you'll also need the following info from each of the editors:
- Their full name
- Their email address
- Their affiliation and its URL
- Their w3cid, which is the number at the end of the url when the editor navigates to https://www.w3.org/users/myprofile
GitHub has a template repository feature which we use for spinning up new repositories for work items and proposals.
Our template repo is privacycg/template.
To create a new repo from this template, click on its "Use this template" button:
You'll end up on a screen that looks like this:
On this page, you'll need to
- Change the owner to @privacycg
- Use the shortname for the repository name
- Provide the description
- Make the repository public
Once you're done, click "Create repository from template".
We how have a repo for the proposal or work item, but you're not done! There are a couple more things to do.
In Settings -> Manage access
, you'll need configure access rights for the repository:
Account or Team | Role |
---|---|
privacycg/all | Read |
privacycg/contributors | Triage |
privacycg/chairs | Maintain |
privacycg/w3t | Maintain |
proposer or editor 1 | Write |
proposer or editor 2 | Write |
.. | .. |
proposer or editor N | Write |
In README.md
, make these edits:
-
Delete everything above the
# [Title]
line -
Right after the
# [Title]
line, there are two sentences:"A Proposal of the Privacy Community Group."
"A Work Item of the Privacy Community Group."
Delete whichever one is not accurate for this proposal or work item.
** If the repo is for a proposal**, you should:
- delete
work-item.bs
from the repo.
If the repo is for a work item, you should:
- rename
work-item.bs
toshortname.bs
- in
shortname.bs
:- set the
Title
,Shortname
,Repository
,Abstract
, andURL
fields appropriately - For each editor, modify or add an
Editor
line filled in like so:Editor: Full Name, w3cid NNNNN, Affiliation https://affiliation.example/, [email protected]
- set the
- Uncomment one of the
Status Text
lines. Which one you should choose depends on the nature of the work item. - Uncomment one of the
Text Macro: LICENSE
lines. Which one you should choose depends on the nature of the work item.