deno.land / x / mongoose@6.7.5 / CONTRIBUTING.md
If you have a question about Mongoose (not a bug report) please post it to either StackOverflow, or on Gitter
if (..) {
for (..) {
while (..) {
function(err) {
npm install
to install the necessary dependenciesnpm run mongo
to start a MongoDB instance on port 27017. This step is optional, if you have already a database running on port 27017. To spin up a specific mongo version, you can do it by executing npm run mongo -- {version}
. E.g. you want to spin up a mongo 4.2.2 server, you execute npm run mongo -- 4.2.2
npm test
to run the tests (we're using mocha)npm test -- -g 'some regexp that matches the test description'
-- <mocha flags here>
npm test -- -R spec
to use the spec reporter, rather than the dot reporter (by default, the test output looks like a bunch of dots)npm run test-tsd
to run the typescript testsnpm run ts-benchmark
to run the typescript benchmark "performance test" for a single time.npm run ts-benchmark-watch
to run the typescript benchmark "performance test" while watching changes on types folder. Note: Make sure to commit all changes before executing this command.To contribute to the API documentation just make your changes to the inline documentation of the appropriate source code in the master branch and submit a pull request. You might also use the github Edit button.
To contribute to the guide or quick start docs, make your changes to the appropriate .pug
/ .md
files in the docs directory of the master branch and submit a pull request. Again, the Edit button might work for you here.
If you'd like to preview your documentation changes, first commit your changes to your local master branch, then execute:
npm install
npm run docs:view
Visit http://localhost:8089
and you should see the docs with your local changes. Make sure you npm run docs:clean
before committing, because automated generated files to docs/*
should not be in PRs.
There are some guidelines to keep the style for the documentation consistent:
guide.html
over ./guide.html
or /docs/guide.html
)The plugins site is also an open source project that you can get involved with. Feel free to fork and improve it as well!
We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
Thank you to all the people who have already contributed to mongoose!
Thank you to all our backers! [Become a backer]
Version Info