File tree Expand file tree Collapse file tree 1 file changed +23
-0
lines changed
Expand file tree Collapse file tree 1 file changed +23
-0
lines changed Original file line number Diff line number Diff line change @@ -29,9 +29,32 @@ Follow these steps:
2929 chmod +x .git/hooks/post-rewrite
3030 ```
3131-->
32+ 1 . [ "How to write a good explainer"] [ explainer ] explains how to make a good first impression.
33+
34+ > Each TC39 proposal should have a ` README.md ` file which explains the purpose
35+ > of the proposal and its shape at a high level.
36+ >
37+ > ...
38+ >
39+ > The rest of this page can be used as a template ...
40+
41+ Your explainer can point readers to the ` index.html ` generated from ` spec.emu `
42+ via markdown like
43+
44+ ``` markdown
45+ You can browse the [ecmarkup output](https://ACCOUNT.github.io/PROJECT/)
46+ or browse the [source](https://github.com/ACCOUNT/PROJECT/blob/master/spec.emu).
47+ ```
48+
49+ where *ACCOUNT* and *PROJECT* are the first two path elements in your project's Github URL.
50+ For example, for github.com/**tc39**/**template-for-proposals**, *ACCOUNT* is "tc39"
51+ and *PROJECT* is "template-for-proposals".
52+
3253
3354## Maintain your proposal repo
3455
3556 1. Make your changes to `spec.emu` (ecmarkup uses HTML syntax, but is not HTML, so I strongly suggest not naming it ".html")
3657 1. Any commit that makes meaningful changes to the spec, should run `npm run build` and commit the resulting output.
3758 1. Whenever you update `ecmarkup`, run `npm run build` and commit any changes that come from that dependency.
59+
60+ [explainer]: https://github.com/tc39/how-we-work/blob/master/explainer.md
You can’t perform that action at this time.
0 commit comments