forked from es5/es5.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md~
53 lines (34 loc) · 1.93 KB
/
README.md~
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Annotated ECMAScript 5
This repo holds a document that provides an annotated HTML view of ECMA 262,
the ECMAScript Language Specification (5th edition). The annotations are
intended to be collaboratively maintained.
## How to contribute annotations
If you would like to contribute annotations, here are the preferred steps:
1. If you don’t have one already, create a [GitHub user account][1].
2. Use the GitHub Web UI to [create your own fork of the es5-spec git
repository][2] and check it out to make a local es5-spec workspace.
3. Create the annotation in your workspace.
[1]: https://github.com/signup/free
[2]: http://github.com/sideshowbarker/es5-spec#fork_box
1. To make an annotation for, for example, section 10.2.1.2 of the ES5
specification, create a file in the `anno` subdirectory of your local es5-spec
workspace named `x10.2.1.2.html` (note the literal `x` at the beginning of the
filename.
2. Add your content to that file. The contents of the file should be and
HTML document fragment (not a complete document—you should omit the `html`,
`head`, and `body` elements).
4. Commit the new annotation to your local git repository, then push it to
your GitHub esf-spec fork.
5. Send a GitHub [es5-spec][3] pull request so that your change can be
committed into this repository and incorporated into the document.
[3]: http://github.com/sideshowbarker/es5-spec/pull/new/gh-pages
## Important
It is important to note that Annotated ECMAScript 5 is **not** a normative
version of the ECMAScript spec. Though it does include the **full text** of
the spec, it is in fact a completely **non-normative** derivative work _based
on_ the spec—strictly for the purpose of explaining the spec and assisting in
its implementation.
![The Javascript mascot: A stylized line drawing of an anthropomorphized globe
with a wry smile on its face.][4]
[4]: http://sideshowbarker.github.com/es5-spec/js-mascot.svg
Ex igne vita.