Skip to content

Commit

Permalink
Update instructions to match new GH UI and build process
Browse files Browse the repository at this point in the history
  • Loading branch information
ljharb committed Jun 9, 2023
1 parent 49ddb39 commit d779d4d
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.md
Expand Up @@ -7,18 +7,19 @@ A repository template for ECMAScript proposals.
Please ensure the following:
1. You have read the [process document](https://tc39.github.io/process-document/)
1. You have reviewed the [existing proposals](https://github.com/tc39/proposals/)
1. You are aware that your proposal requires being a member of TC39, or locating a TC39 delegate to "champion" your proposal
1. 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"](https://github.com/tc39/template-for-proposals/generate) 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)
1. Update the biblio to the latest version: `npm install --save-dev --save-exact @tc39/ecma262-biblio@latest`.
1. Go to your repo settings “Options” page, under “GitHub Pages”, and set the source to `gh-pages` under the root and click Save. You may need to wait a minute or so after creating the repo for the initial build to finish and create the branch.
1. Check "Enforce HTTPS"
1. On "Options", under "Features", Ensure "Issues" is checked, and disable "Wiki", and "Projects" (unless you intend to use Projects)
1. Under "Merge button", check "automatically delete head branches"
1. ["How to write a good explainer"][explainer] explains how to make a good first impression.
1. Click the green [“use this template”](https://github.com/tc39/template-for-proposals/generate) 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)
1. 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`.
1. 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)
1. Under “Pull Requests”, check “Always suggest updating pull request branches” and “automatically delete head branches”
1. Under the “Pages” section on the left sidebar, and set the source to “deploy from a branch” and check “Enforce HTTPS”
1. Under the “Actions” section on the left sidebar, under “General”, select “Read and write permissions” under “Workflow permissions” and click “Save”
1. [“How to write a good explainer”][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.
Expand All @@ -36,14 +37,14 @@ Follow these steps:
```

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".
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")
1. Any commit that makes meaningful changes to the spec, should run `npm run build` and commit the resulting output.
1. Whenever you update `ecmarkup`, run `npm run build` and commit any changes that come from that dependency.
1. Make your changes to `spec.emu` (ecmarkup uses HTML syntax, but is not HTML, so I strongly suggest not naming it .html)
1. 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.
1. Whenever you update `ecmarkup`, run `npm run build` to verify that the build will succeed and the output looks as expected.

[explainer]: https://github.com/tc39/how-we-work/blob/HEAD/explainer.md

0 comments on commit d779d4d

Please sign in to comment.