Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 2.96 KB

README.md

File metadata and controls

50 lines (37 loc) · 2.96 KB
Raw

template-for-proposals

A repository template for ECMAScript proposals.

Before creating a proposal

Please ensure the following:

  1. You have read the process document
  2. You have reviewed the existing proposals
  3. You are aware that your proposal requires being a member of TC39, or locating a TC39 delegate to “champion” your proposal

Create your proposal repo

Follow these steps:

  1. Click the green “use this template” button in the repo header. (Note: Do not fork this repo in GitHub's web interface, as that will later prevent transfer into the TC39 organization)

  2. Update ecmarkup and the biblio to the latest version: npm install --save-dev ecmarkup@latest && npm install --save-dev --save-exact @tc39/ecma262-biblio@latest.

  3. Go to your repo settings page:

    1. Under “General”, under “Features”, ensure “Issues” is checked, and disable “Wiki”, and “Projects” (unless you intend to use Projects)
    2. Under “Pull Requests”, check “Always suggest updating pull request branches” and “automatically delete head branches”
    3. Under the “Pages” section on the left sidebar, and set the source to “deploy from a branch”, select “gh-pages” in the branch dropdown, and then ensure that “Enforce HTTPS” is checked.
    4. Under the “Actions” section on the left sidebar, under “General”, select “Read and write permissions” under “Workflow permissions” and click “Save”

  4. “How to write a good explainer” explains how to make a good first impression.

    Each TC39 proposal should have a README.md file which explains the purpose of the proposal and its shape at a high level.

    ...

    The rest of this page can be used as a template ...

    Your explainer can point readers to the index.html generated from spec.emu via markdown like

    You can browse the [ecmarkup output](https://ACCOUNT.github.io/PROJECT/)
or browse the [source](https://github.com/ACCOUNT/PROJECT/blob/HEAD/spec.emu).

    where ACCOUNT and PROJECT are the first two path elements in your project's Github URL. For example, for github.com/tc39/template-for-proposals, ACCOUNT is “tc39” and PROJECT is “template-for-proposals”.

Maintain your proposal repo

  1. Make your changes to spec.emu (ecmarkup uses HTML syntax, but is not HTML, so I strongly suggest not naming it “.html”)
  2. Any commit that makes meaningful changes to the spec, should run npm run build to verify that the build will succeed and the output looks as expected.
  3. Whenever you update ecmarkup, run npm run build to verify that the build will succeed and the output looks as expected.