Permalink
Fetching contributors…
Cannot retrieve contributors at this time
43 lines (21 sloc) 2.02 KB

Contributing to Uglifier

Any contributions to Uglifier are welcome, whether they are feedback, bug reports, or - even better - pull requests.

Development

To start working on Uglifier, fork the repo to your own account. Ruby, bundler and Node.js are required as dependencies.

Ensure that your local copy is up-to-date before you start working on a feature or a bug fix. You should write any new code in a topic branch.

Tests

Try to write a test case that reproduces the problem you're trying to fix or describes a feature that you want to build. Tests are located in spec/ directory.

Tests as a pull request are appreciated even without a fix to highlight or reproduce a problem.

To run tests, first install all project dependencies:

bundle install

Then run tests using rake:

bundle exec rake

Updating UglifyJS and source-map

UglifyJS and source-map are included in the project as Git submodules. To install submodules, run in your terminal

git submodule update --init

After that, UglifyJS and source-map are checked out under vendor/uglifyjs and vendor/source-map.

Use Git commands (e.g. git checkout master) to change the included version. You can even write custom code to yourself. After changing the dependencies, compile new version of the bundled JS file using

bundle exec rake js

After this, the new JS is used in your development version.

Reporting issues

Uglifier uses the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and ExecJS runtime. Ideally, a bug report should include a pull request with failing specs.