Skip to main content
Module

x/mandarinets/docs/contributing.md

Mandarine.TS is a typescript, decorator-driven framework that allows you to create server-side applications. Mandarine.TS provides a range of built-in solutions such as Dependency Injection, Components, ORM and more. Under its umbrella, Mandarine.TS has 4 modules: Core, Data, Security and MVC, these modules will offer you the requirements to build a Mandarine-powered application.
mandarineorg/mandarinets
Latest
File

Contributing

  • Read the style guide
  • Ask for help in the community chat room
  • If you are going to work on an issue:
    • Comment the issue & understand what the issue is about
    • Make sure no one else is working on it already
    • Assign it to you
    • Investigate everything you have to investigate

Self-dependency

We want to be as self-dependent as we can, this means, the less external modules or third-party codes we have, the better.

How to run

  1. Start by cloning this repository into your local machine.
  2. To run the tests, use the command deno test -c tsconfig.json --allow-all

Branch

  • When starting to work on an issue, you must always branch off of master

Steps

Before submitting, please make sure the following is done:

  1. You have branched off of develop for your current issue & PR
  2. That there is a related issue and it is referenced in the PR text
  3. There are tests that cover the changes
  4. Github CI is passing
  5. Your code is documented with JSDoc

External modules

If your code requires a third-party module or a module from deno/std, you will need to add this module to the following repository: mandarinets-modules.
It is likely you will need help from @andreespirela.