Home

You're great! 🙌

no really, you're great.

Welcome to compromise. We welcome all contributions, and help.

If you're looking for a fun open-source project to help-out with:

• hunt around for some bugs (there's lots!)
• new devs should write a buncha tests ❤️
• library-users can fix the docs, share your work, or
• javascripters can pickup a Todo or an open issue.

Asking for help:

Please help us 🤕 avoid open-source-burnout, before requiring help:

1. is your answer in the official docs?
2. is your answer in the wiki?
3. is your answer on stackOverflow?
4. has your question already been asked?
5. can it be fixed using a custom lexicon?

If you're looking for advice or help using the library, join our slack group instead of making an issue.

Thanks!

Creating an issue

If you've found a bug, please check if you're running the latest version:

var nlp=require('compromise')
console.log(nlp.version)

When you're creating an issue, please try to isolate the issue to the smallest case you can.

it's also pretty cool to make a runkit or jsfiddle or plunker for the issue