Files
coffeescript/documentation/sections/contributing.md

1.5 KiB

Contributing

Contributions are welcome, feel free to fork a copy and submit a pull request.

If there is a core part of ECMAScript you think we are missing, head on over to CoffeeScript issues on GitHub, and dig around in the open and closed issues.

For more resources on adding to CoffeeScript, please see the Wiki or How The Parser Works if you are interested in learning how the parser works.

There are several things you can do to increase your odds of having the pull request accepted:

  • Create tests! Any pull request should probably include basic tests to verify you didn't break anything, or future changes won't break your code.
  • Follow the CoffeeScript style guide
  • Ensure any ECMAScript addition is mature (at Stage 4), with no further potential syntax changes.
  • Adding only the features that help the community rather than a specific use case.

Of course, it's entirely possible that you have a great addition, but it doesn't fit directly with the CoffeeScript code base.

This might be the time to...

Roll Your Own

You are of course, welcome to fork the language and add in the features you want. There are quite a few really interesting projects that have done so, and more are welcome.