Merge pull request #69 from algorandfoundation/update-alpha

Update alpha from main

Author: boblat

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: "\U0001F41C Bug report"
+about: Report a reproducible bug.
+title: ''
+labels: new-bug
+assignees: ''
+---
+
+### Subject of the issue
+
+<!-- Describe your issue here. -->
+
+### Your environment
+
+<!--
+* Please provide information about your environment.
+* This will give us a good idea about your environment
+-->
+
+### Steps to reproduce
+
+1.
+2.
+
+### Expected behaviour
+
+### Actual behaviour

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: "\U0001F514 Feature Request"
+about: Suggestions for how we can improve the algorand platform.
+title: ''
+labels: new-feature-request
+assignees: ''
+---
+
+## Problem
+
+<!-- What is the problem that we’re trying to solve? -->
+
+## Solution
+
+<!-- Do you have a potential/suggested solution? Document more than one if possible. -->
+
+### Proposal
+
+<!-- Describe the solution you’d like in detail. -->
+
+### Pros and Cons
+
+<!-- What are the advantages and disadvantages of this solution? -->
+
+## Dependencies
+
+<!-- Does the solution have any team or design dependencies? -->

.github/workflows/pr.yml

@@ -9,7 +9,6 @@ on:
       - 'docs/**'
       - 'scripts/**'
 
-
 permissions:
   contents: read
 
@@ -19,8 +18,9 @@ jobs:
     uses: ./.github/workflows/node-ci.yml
     with:
       pre-test-script: |
-        pipx install algokit
-        algokit localnet start
+        pipx install algokit --python 3.12.6
+        algokit localnet reset --update
+        pipx install puyapy --python 3.12.6
       node-version: 20.x
       run-build: true
       run-commit-lint: true

.github/workflows/release.yml

@@ -22,7 +22,8 @@ jobs:
     with:
       pre-test-script: |
         pipx install algokit
-        algokit localnet start
+        algokit localnet reset --update
+        pipx install puyapy
       node-version: 20.x
       run-build: true
       run-commit-lint: true
@@ -63,3 +64,5 @@ jobs:
           token: ${{ secrets.NPM_TOKEN }}
           package: artifacts/algo-ts-testing/package.json
           access: 'public'
+          # Tagging 'main' branch with latest for now, even though it's beta because we don't have a non-beta
+          tag: ${{ github.ref_name == 'alpha' && 'alpha' || github.ref_name == 'main' && 'latest' || github.ref_name == 'release' && 'latest' || 'pre-release' }}

.gitignore

@@ -65,3 +65,4 @@ out/
 
 
 examples/debug-out/
+examples/**/data/

.tstoolkitrc.ts

@@ -10,7 +10,11 @@ const config: TsToolkitConfig = {
     exports: {
       '.': 'index.ts',
       './runtime-helpers': 'runtime-helpers.ts',
-      './test-transformer': 'test-transformer/index.ts',
+      './internal': 'internal/index.ts',
+      './internal/arc4': 'internal/arc4.ts',
+      './internal/op': 'internal/op.ts',
+      './vitest-transformer': 'test-transformer/vitest-transformer.ts',
+      './jest-transformer': 'test-transformer/jest-transformer.ts',
     },
   },
 }

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing to Algorand TypeScript Testing
+
+Contributions are welcome. For new features, please open an issue to discuss first.
+
+## Workflow
+
+We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary). 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](https://nodejs.org/).
+
+1. **Install Python 3.12+**.
+
+1. **Install Puya**:
+
+   ```sh
+   pipx install puyapy --python 3.12.6
+   ```
+
+1. **Install AlgoKit CLI**: Follow the guide from [Algokit](https://github.com/algorandfoundation/algokit-cli?tab=readme-ov-file#install).
+
+1. **Start localnet**:
+
+   ```sh
+   algokit localnet start
+   # or `algokit localnet reset --update` to update localnet docker images
+   ```
+
+1. **Install npm dependencies**:
+
+   ```sh
+   npm install
+   ```
+
+1. **Run tests**:
+   ```sh
+   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`