Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (33 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.41 KB

Contributing to Algorand TypeScript Testing

Contributions are welcome. For new features, please open an issue to discuss first.

Workflow

We use Conventional Commits. User-facing changes should include at least one fix: or feat: commit for release notes. Other conventions like docs: or test: are optional but helpful.

Local Development

To set up the project locally:

  1. Install Node.js: Download from nodejs.org.

  2. Install Python 3.12+.

  3. Install Puya:

    pipx install puyapy --python 3.12.6

  4. Install AlgoKit CLI: Follow the guide from Algokit.

  5. Start localnet:

    algokit localnet start
# or `algokit localnet reset --update` to update localnet docker images

  6. Install npm dependencies:

    npm install

  7. Run tests:

    npm test

Common Commands

Here are some common commands you will use with npm:

  • Generate API reference documentation npm run script:documentation
  • Fix linting errors npm run lint:fix
  • Build a distribution locally npm run build
  • Compile all contracts used by tests for debugging npm run script:refresh-test-artifacts
  • Compile all example contracts for debugging npm run script:compile-examples