Skip to content

Latest commit

 

History

History
100 lines (65 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

100 lines (65 loc) · 2.47 KB
Raw

Contributing

We welcome you to join the development of Moleculer. This document helps you through the process.

Before You Start

Please follow the coding style:

  • Use tabs with size of 4 for indents.
  • Always use strict mode & semicolons.
  • Use double quotes instead of single quotes.

Contribution in the core modules

Follow this workflow if you would like to modify the core modules.

Workflow

  1. Fork the moleculerjs/moleculer repo.

  2. Clone the repository to your computer and install dependencies.

    $ git clone https://github.com/<username>/moleculer.git
$ cd moleculer
$ npm install

  3. Start Moleculer in dev mode

    $ npm run dev

    or in continuous test mode

    $ npm run ci

  4. Fix the bug or add a new feature.

  5. Run tests & check the coverage report.

    $ npm test

    If you added new features, please add relevant new test cases! We aim to 100% cover.

    {% note info %} Your pull request will only get merged when tests passed and covered all codes. Don't forget to run tests before submission. {% endnote %}

  6. Commit & push the branch.

  7. Create a pull request and describe the change.

  8. If you've changed APIs, update the documentation as well.

Contribution to create a new Moleculer module

Follow this workflow if you would like to create a new module for Moleculer

Workflow

  1. Install the command-line tool.

    $ npm install moleculer-cli -g

  2. Create a new module skeleton (named moleculer-awesome).

    $ moleculer init module moleculer-awesome

  3. Edit src/index.js and implement the logic.

  4. For development use the dev mode (it starts your module with example/simple/index.js)

    $ npm run dev

    or the continuous test mode

    $ npm run ci

  5. Create tests in test/unit/index.spec.js & cover the full source.

    $ npm test

  6. If it's done and you think it will be useful for other users, tell us!

Reporting Issues

When you encounter some problems when using Moleculer, you can find the solutions in FAQ or ask us on Discord chat. If you can't find the answer, please report it on GitHub Issues.

Thank you!