Skip to content
spencer kelly edited this page Jul 5, 2017 · 28 revisions

You're great! 🙌

no really, you're great.

we welcome all contributions, hacking, and help.

Asking for help:

Please help us avoid open-source-burnout:face_with_head_bandage:, 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?

Thanks!

Creating an issue

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

If you believe you've found a bug, please make sure 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 piece of text you can, and identify the method that is giving you unexpected results.

it's pretty cool to make a runkit or jsfiddle or plunker to show your failing case, too.