Document your code
Every project on GitHub comes with a version-controlled wiki to give your documentation the high level of care it deserves. It’s easy to create well-maintained, Markdown or rich text documentation alongside your code.
Sign up for free See pricing for teams and enterprisesHome
Welcome to compromise
We welcome all contributions, help, and ideas.Questions:
Please help us 
- is your answer in the official docs?
- has your question already been asked?
- is your answer on stackOverflow?
- can it be fixed using a custom lexicon?
If you're looking for advice or help using the library, join our community chat instead of making an issue.
Thanks!
Contributing
If you're looking for a fun open-source project to help-out with:
- hunt around for some bugs (there's lots!)
- new devs can write a buncha tests
- library-users can fix the docs, share your work
- pickup an open issue.
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 Thanks