Skip to content

Magnustravels/Temp-

 
 

Repository files navigation

What this repository is about

This repository contains the backend part of arcanum protocol ecosystem

How to read this repository

Each folder is named before the microservice it implements. All microservices have their docker containers and are run through deno runtime

How to contribute

RULES


Commit messages

Commit naming rule are the same as for issues, but you need to add the number of the issue in the end of the commit message.

Pattern

[AREA]:[WHAT_IN_THE_COMMIT] (#[NUMBER_OF_ISSUE])

Example

OPS: finalize deployers (#41)


Branches

Branches naming rule are the same as for issues, but you need to add the number of the issue in the start of the branch name.

Pattern

feat/[NUMBER_OF_ISSUE]_[AREA]_[DESCRIPTION_FROM_ISSUE]

Example

feat/41_MULTIPOOL_add_testnet_deploy_scripts


Issues

Issues naming rule are the same as for commits.

Pattern

[AREA]:[WHAT_TO_DO_OR_FIX]

Example

OPS: add testnet deploy scripts to all infrastructure


STEPS FOR CONTRIBUTION IN THE EXISTING CODE

1. UNDERSTAND AREA Understand in which part of the contracts there is a code that you want to change
Area Description
0xAPI 0x api /swap/v1/quote implementation
API arcanum api implementation
2. CREATE ISSUE Create a new issue in the repository with the description of the problem and the solution. Then make new branch from the master branch with the name of the issue.
3. PULL REQUEST Make changes in the code and commit them. Then open a pull request to the master branch. After that, the pull request will be reviewed and rebased.

STEPS FOR CONTRIBUTION IN THE NEW CODE

1. MAKE ISSUE AND BRANCH

Create a new issue in the repository with the description of the problem and the solution.

Then make new branch from the master branch with the name of the issue.

2. ORGANAZE

Make a new folder in the contracts folder with the name of the new part of provisior.

Then make a new folder in the test folder with the name of the new code. With test cases for the new code.

Then make a new folder in the deployments folder with the name of the new code. With deployers and verifiers.

3. PULL REQUEST

Make changes in the code and commit them.

Then open a pull request to the master branch. After that, the pull request will be reviewed and rebased.

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 95.2%
  • PLpgSQL 3.8%
  • Dockerfile 1.0%