Skip to content

Latest commit

 

History

History
89 lines (61 loc) · 6.42 KB

CONTRIBUTING.md

File metadata and controls

89 lines (61 loc) · 6.42 KB
Raw

Contributing to Mongoose

If you have a question about Mongoose (not a bug report) please post it to either StackOverflow, or on Gitter

Reporting bugs

  • Before opening a new issue, look for existing issues to avoid duplication. If the issue does not yet exist, create one.
    • Please post any relevant code samples, preferably a standalone script that reproduces your issue. Do not describe your issue in prose. Show your code.
    • If the bug involves an error, please post the stack trace.
    • Please post the version of Mongoose and MongoDB that you're using.
    • Please write bug reports in JavaScript (ES5, ES6, etc) that runs in Node.js, not CoffeeScript, TypeScript, JSX, etc.

Requesting new features

  • Before opening a new issue, look for existing issues to avoid duplication. If the issue does not yet exist, create one.
  • Please describe a use case for it
  • Please include test cases if possible

Fixing bugs / Adding features

  • Before starting to write code, look for existing issues. That way you avoid working on something that might not be of interest or that has been addressed already in a different branch. You can create a new issue here.
    • The source of this project is written in JavaScript, not CoffeeScript or TypeScript. Please write your bug reports in JavaScript that can run in vanilla Node.js.
  • Fork the repo or for small documentation changes, navigate to the source on github and click the Edit button.
  • Follow the general coding style of the rest of the project:
    • 2 space tabs
    • no trailing whitespace
    • inline documentation for new methods, class members, etc.
    • 1 space between conditionals, no space before function parenthesis
      • if (..) {
      • for (..) {
      • while (..) {
      • function(err) {
  • Write tests and make sure they pass (tests are in the test directory).
  • Write typings-tests if you modify the typescript-typings. (tests are in the test/types directory).

Running the tests

  • Open a terminal and navigate to the root of the project
  • execute npm install to install the necessary dependencies
  • execute npm 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
  • execute npm test to run the tests (we're using mocha)
    • or to execute a single test npm test -- -g 'some regexp that matches the test description'
    • any mocha flags can be specified with -- <mocha flags here>
    • For example, you can use 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)
    • execute npm run test-tsd to run the typescript tests
    • execute npm run ts-benchmark to run the typescript benchmark "performance test" for a single time.
    • execute 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.

Documentation

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://127.0.0.1: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.

Documentation Style Guidelines

There are some guidelines to keep the style for the documentation consistent:

  • All links that refer to some other file in the mongoose documentation needs to be relative without a prefix unless required (use guide.html over ./guide.html or /docs/guide.html)

Plugins website

The plugins site is also an open source project that you can get involved with. Feel free to fork and improve it as well!

Financial contributions

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.

Credits

Contributors

Thank you to all the people who have already contributed to mongoose!

Backers

Thank you to all our backers! [Become a backer]