You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2.0 KiB

Development

PEG.js is currently maintained by Futago-za Ryuu (@futagozaryuu).

Since it's inception in 2010, PEG.js was maintained by David Majda (@dmajda), until May 2017.

The Bower package is maintained by Michel Krämer (@michelkraemer).

Contribution

You are welcome to contribute code using GitHub pull requests. Unless your contribution is really trivial you should get in touch with me first (preferably by creating a new issue on the issue tracker) - this can prevent wasted effort on both sides.

Before submitting a pull request, please make sure you've checked out the Contribution Guidelines.

  1. Create a fork of https://github.com/pegjs/pegjs
  2. Clone your fork, and optionally create a new branch
  3. Run the command npm install from the root of your clone
  4. Add and commit your changes
  5. Validate your changes:
    • Lint the JavaScript changes (command line only, run gulp lint or npm run lint)
    • Run tests to ensure nothing's broken: see separate documentation
  6. If validation fails: reverse your commit, fix the problem and then add/commit again
  7. Push the commits from your clone to the fork
  8. From your fork, start a new pull request

It's also a good idea to check out the gulpfile.js that defines various tasks that are commented with a description of each task.

To see the list of contributors check out the repository's contributors page.