- 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
We want to be as self-dependent as we can, this means, the less external modules or third-party codes we have, the better.
- Start by cloning this repository into your local machine.
- To run the tests, use the command
deno test -c tsconfig.json --allow-all
- Check how we run our unit tests
- Check how we run our copyright test
- Check how we run our integration tests
- check how we run our PG rust driver tests
- When starting to work on an issue, you must always branch off of
master
Before submitting, please make sure the following is done:
- You have branched off of
develop
for your current issue & PR - That there is a related issue and it is referenced in the PR text
- There are tests that cover the changes
- Github CI is passing
- Your code is documented with JSDoc
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.