Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
- Always use GitHub Issues to create new issues.
-
The master branch is just a snapshot of the latest stable release. All development should be done in dedicated branches. Do not submit PRs against the master branch.
-
Checkout a topic branch from a base branch, e.g.
dev
, and merge back against that branch. -
It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.
-
Commit messages must follow the commit message convention. Commit messages are automatically validated before commit (by invoking Git Hooks via husky).
-
No need to worry about code style as long as you have installed the dev dependencies - modified files are automatically formatted with Prettier on commit (by invoking Git Hooks via husky).
You will need Node.js version 18+ and pnpm.
After cloning the repo, run:
pnpm i # install the dependencies of the project
The airdrop
script starts base Airdrop script without arguments.
npm run airdrop ./config.jsonc
The validate
script starts Airdrop script with --validate
flag for input file validation.
npm run validate ./config.jsonc
The version
script shows the software version.
npm run version
The setup
script runs Airdrop setup.
npm run setup