Skip to content
This repository has been archived by the owner on Aug 22, 2023. It is now read-only.

Latest commit

 

History

History
34 lines (27 loc) · 1.67 KB

README.md

File metadata and controls

34 lines (27 loc) · 1.67 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 member to "champion" your proposal

Create your proposal repo

Follow these steps:

  1. Create your own repo, clone this one, and copy its contents into your repo. (Note: Do not fork this repo in GitHub's web interface, as that will later prevent transfer into the TC39 organization)
  2. Go to your repo settings “Options” page, under “GitHub Pages”, and set the source to the master branch and click Save.
    1. Ensure "Issues" is checked.
    2. Also, you probably want to disable "Wiki" and "Projects"
  3. Avoid merge conflicts with build process output files by running: 
    git config --local --add merge.output.driver true
git config --local --add merge.output.driver true
  4. Add a post-rewrite git hook to auto-rebuild the output on every commit: 
    cp hooks/post-rewrite .git/hooks/post-rewrite
chmod +x .git/hooks/post-rewrite

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 and commit the resulting output.
  3. Whenever you update ecmarkup, run npm run build and commit any changes that come from that dependency.