Contributing
============

## Documentation

Every new feature and API change should be accompanied by a README additon.

## Testing

All features and bugs should have tests that verify the fix. You can run all
tests using `npm test`.

The most common type of test are tests that verify input and output of the
Uglify transforms. These tests exist in `test/compress`. New tests can be added
either to an existing file or in a new file `issue-xxx.js`.

Tests that cannot be expressed as a simple AST can be found in `test/mocha`.

## Code style

- File encoding must be `UTF-8`.
- `LF` is always used as a line ending.
- Statements end with semicolons.
- Indentation uses 4 spaces, switch `case` 2 spaces.
- Identifiers use `snake_case`.
- Strings use double quotes (`"`).
- Use a trailing comma for multiline array and object literals to minimize diffs.
- The Uglify code only uses ES5, even in the `harmony` branch.
- Line length should be at most 80 cols, except when it is easier to read a
  longer line.
- If both sides of a comparison are of the same type, `==` and `!=` are used.
- Multiline conditions place `&&` and `||` first on the line.

**Example feature**

```js
OPT(AST_Debugger, function(self, compressor) {
    if (compressor.option("drop_debugger"))
        return make_node(AST_EmptyStatement, self);
    return self;
});
```

**Example test case**

```js
drop_debugger: {
    options = {
        drop_debugger: true,
    }
    input: {
        debugger;
        if (foo) debugger;
    }
    expect: {
        if (foo);
    }
}
```


 action='/guix/log/manifest.scm'>
<input type='hidden' name='id' value='a764329488eaed217903ef610d93442cb008a520'/><select name='qt'>
<option value='grep'>log msg</option>
<option value='author'>author</option>
<option value='committer'>committer</option>
<option value='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/guix/log/?id=a764329488eaed217903ef610d93442cb008a520'>root</a>/<a href='/guix/log/manifest.scm?id=a764329488eaed217903ef610d93442cb008a520'>manifest.scm</a></div><div class='content'><table class='list nowrap'><tr class='nohover'><th class='left'>Age</th><th class='left'>Commit message (<a href='/guix/log/manifest.scm?id=a764329488eaed217903ef610d93442cb008a520&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2024-06-24 08:51:43 -0400'>2024-06-24</span></td><td><a href='/guix/commit/manifest.scm?id=7f194852a46edfe47537d11bc39fb1dd20e18b37'>manifest: Streamline; add packages useful for patch review/submission.</a><span class='msg-avail'>...<span class='msg-tooltip'>* manifest.scm: Fix alternate command line invocation (which would not
consider 'manifest.scm').  Use specifications instead of packages.  Remove
perl (now in the guix package's native inputs).  Add b4, git, git:send-email,
mumi, nss-certs, openssl and patman to the manifest.

Change-Id: I49d92dda059856ce217cea9054a466a1754dcf94
Signed-off-by: Maxim Cournoyer &lt;maxim.cournoyer@gmail.com&gt;
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2024-04-02 23:28:58 +0200'>2024-04-02</span></td><td><a href='/guix/commit/manifest.scm?id=049273bb8c1ea3d6402db646312acdc4abf4678a'>maint: Add perl to the manifest.</a><span class='msg-avail'>...<span class='msg-tooltip'>* manifest.scm: Add perl.

Change-Id: Ie70cea1eb4d62f2a649292209391a92abdae2288
</span></span></td><td>Janneke Nieuwenhuizen</td></tr>
<tr><td><span title='2024-01-31 09:07:25 +0100'>2024-01-31</span></td><td><a href='/guix/commit/manifest.scm?id=66dd088d3c3404f5cbe2d4d4c5e8f93d184703b0'>maint: Add gnupg to the manifest.</a><span class='msg-avail'>...<span class='msg-tooltip'>* manifest.scm: Add gnupg.

Change-Id: Id5e90f87e5c3a07aa3e49afa97cc0b6d3ce71b41
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2023-09-18 22:12:39 +0200'>2023-09-18</span></td><td><a href='/guix/commit/manifest.scm?id=7bf12820f61179900f9d1f753acf91fd33724976'>maint: Support `guix shell' in Guix's git archive with manifest.scm.</a><span class='msg-avail'>...<span class='msg-tooltip'>* manifest.scm: New file.
* Makefile.am (EXTRA_DIST): Add it.
* doc/contributing.texi (Building from Git): Mention using it.
</span></span></td><td>Janneke Nieuwenhuizen</td></tr>