Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
bathos committed Aug 25, 2021
0 parents commit b90d612
Show file tree
Hide file tree
Showing 9 changed files with 2,508 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitattributes
@@ -0,0 +1,3 @@
index.html -diff merge=ours
spec.js -diff merge=ours
spec.css -diff merge=ours
19 changes: 19 additions & 0 deletions .github/workflows/build.yml
@@ -0,0 +1,19 @@
name: Deploy spec

on: [push]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: '12.x'
- run: npm install
- run: npm run build
- name: commit changes
uses: elstudio/actions-js-build/commit@v3
with:
commitMessage: "fixup: [spec] `npm run build`"
43 changes: 43 additions & 0 deletions .gitignore
@@ -0,0 +1,43 @@
# Logs
logs
*.log
npm-debug.log*

# Runtime data
pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules
jspm_packages

# Optional npm cache directory
.npm

# Optional REPL history
.node_repl_history

# Only apps should have lockfiles
yarn.lock
package-lock.json
npm-shrinkwrap.json
pnpm-lock.yaml
1 change: 1 addition & 0 deletions .npmrc
@@ -0,0 +1 @@
package-lock=false
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2017 ECMA TC39 and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
60 changes: 60 additions & 0 deletions README.md
@@ -0,0 +1,60 @@
# template-for-proposals

A repository template for ECMAScript proposals.

## Before creating a proposal

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

## 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. Go to your repo settings “Options” page, under “GitHub Pages”, and set the source to the **main branch** under the root (and click Save, if it does not autosave this setting)
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. Avoid merge conflicts with build process output files by running:
```sh
git config --local --add merge.output.driver true
git config --local --add merge.output.driver true
```
1. Add a post-rewrite git hook to auto-rebuild the output on every commit:
```sh
cp hooks/post-rewrite .git/hooks/post-rewrite
chmod +x .git/hooks/post-rewrite
```
-->
3. ["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.
>
> ...
>
> 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

```markdown
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")
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.

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

0 comments on commit b90d612

Please sign in to comment.