indexer-sdk
v1.0.1
Published
Client for the Voltz indexers living on Google Cloud
Downloads
3
Readme
indexer-sdk
| Statements | Branches | Functions | Lines | | --------------------------- | ----------------------- | ------------------------- | ----------------- | | | | | |
Installation
- Run
yarn
Contributing
Branching model
You should branch off main
when building a feature.
So just go on main
, pull latest and then branch out of it.
Create your PR against main
.
Branch naming is quite standard, we tried to duplicate what we have done for the committing messages, following standard commit message format: [https://www.conventionalcommits.org/en/v1.0.0/].
Branch names can start with the prefixes found in the regex under '.husky/pre-commit'.
Short summary:
DEVELOPING
- create a branch from
main
, follow the naming convention for a branch - wait for approval, resolve comments and make sure you have a green build
- merge to
main
using Rebase and merge
Rules
Environment branches (main)
- merges to branch
main
always release a version tonpm
Candidate branches:
- commits on branches that follow the pattern
feat/*
,fix/*
,chore/*
,refactor/*
andtest/*
Terms & Conditions
The Voltz Protocol, and any products or services associated therewith, is offered only to persons (aged 18 years or older) or entities who are not residents of, citizens of, are incorporated in, owned or controlled by a person or entity in, located in, or have a registered office or principal place of business in any “Restricted Territory.”
The term Restricted Territory includes the United States of America (including its territories), Algeria, Bangladesh, Bolivia, Belarus, Myanmar (Burma), Côte d’Ivoire (Ivory Coast), Egypt, Republic of Crimea, Cuba, Democratic Republic of the Congo, Iran, Iraq, Liberia, Libya, Mali, Morocco, Nepal, North Korea, Oman, Qatar, Somalia, Sudan, Syria, Tunisia, Venezuela, Yemen, Zimbabwe; or any jurisdictions in which the sale of cryptocurrencies are prohibited, restricted or unauthorized in any form or manner whether in full or in part under the laws, regulatory requirements or rules in such jurisdiction; or any state, country, or region that is subject to sanctions enforced by the United States, such as the Specially Designed Nationals and Blocked Persons List (“SDN List”) and Consolidated Sanctions List (“Non-SDN Lists”), the United Kingdom, or the European Union.