Merge branch 'main' into styling-logo

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Report any bugs or unexpected behaviour in the tutorials site
+title: "bug: "
+labels: bug, track:maintenance
+assignees: ""
+---
+
+### Problem
+
+A clear and concise description of what the bug is.
+
+### To reproduce
+
+If you can reproduce the behaviour, steps to reproduce:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Expected behaviour
+
+A clear and concise description of what you expected to happen.
+
+### Screenshots/logs
+
+If applicable, add screenshots or logs to help explain your problem.
+
+### tutorial version/commit hash
+
+State the version of tutorials where you've encountered the bug or, if built off a specific commit, the relevant commit hash.
+
+- e.g. `v0.9` or `ed53bcd`
+
+### Additional context
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+contact_links:
+  - name: Questions & Support Requests
+    url: https://discord.gg/cowprotocol
+    about: Ask in the CoW Protocol Discord

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest an idea for the tutorials (not currently covered)
+title: "feat: "
+labels: track:production
+assignees: ""
+---
+
+### Problem
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+### Suggested solution
+
+A clear and concise description of what you want to happen.
+
+### Alternatives considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+### Additional context
+
+Add any other context or screenshots about the feature request here.
+
+### Acceptance criteria
+
+A list of tasks that need to be done for the issue to be considered resolved.

.github/ISSUE_TEMPLATE/improvement.md

@@ -0,0 +1,19 @@
+---
+name: Improvement
+about: Suggest improvements to the tutorials.
+title: "chore:"
+labels: track:maintenance
+assignees: ""
+---
+
+### Background
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]; There is a spelling error in [...]; It's difficult to understand the tutorial in [...]
+
+### Details
+
+A clear and concise description of what you want to happen.
+
+### Acceptance criteria
+
+A list of tasks that need to be done for the issue to be considered resolved.

.github/pull_request_template.md

@@ -0,0 +1,16 @@
+# Description
+
+<!--- Describe your changes to provide context for reviewers, including why it is needed -->
+
+# Changes
+
+<!-- List of detailed changes (how the change is accomplished) -->
+
+- [ ] ...
+- [ ] ...
+
+<!--
+## Related Issues
+
+Fixes #
+-->

.github/workflows/add-to-project.yml

@@ -0,0 +1,16 @@
+name: Add new issues to project board
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  add-to-project:
+    if: github.repository_owner == 'cowprotocol'
+    name: Add issue to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          project-url: https://github.com/orgs/cowprotocol/projects/8
+          github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}

.github/workflows/cla.yml

@@ -0,0 +1,23 @@
+name: "cla"
+
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened, closed, synchronize]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "CLA Assistant"
+        if: ((github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target') && github.repository_owner == 'cowprotocol' && github.repository != 'cowprotocol/cla'
+        uses: contributor-assistant/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PERSONAL_ACCESS_TOKEN : ${{ secrets.ORG_TOKEN }}
+        with:
+          branch: 'cla-signatures'
+          path-to-signatures: 'signatures/version1/cla.json'
+          path-to-document: 'https://github.com/cowprotocol/cla/blob/main/CLA.md'
+          allowlist: '*[bot]'

README.md

@@ -1,25 +1,29 @@
-# CoW Tutorial
+<p align="center">
+   <img alt="CoW Protocol Logo" width="400" src="./.github/cow.png">
+</p>
 
-A soup-to-nuts interactive tutorial on how to build apps with Svelte.
+# CoW Tutorials
+
+A grass-to-glass tutorial on how to build with CoW Protocol.
 
 ## Setup
 
-This repo uses [pnpm](https://pnpm.io/).
+This repo uses [yarn](https://yarnpkg.com/).
 
 ## Developing the app
 
-First, run `node scripts/create-common-bundle`. This packages up everything that's needed to run a SvelteKit app (Vite, esbuild, SvelteKit, Svelte compiler, etc.) which can subsequently be unpacked on a server to create and run an instance of a SvelteKit application (which powers the output window of the tutorial). Then, run `dev`:
+First, run `node scripts/create-common-bundle`. This packages up everything that's needed to run the app within the webcontainer (Vite, typescript, CoW dependencies, etc.) which can subsequently be unpacked on a server to create and run an instance of a CoW application (which powers the output window of the tutorial). Then, run `dev`:
 
 ```bash
 node scripts/create-common-bundle
-pnpm dev
+yarn dev
 ```
 
 To build for production and run locally:
 
 ```bash
-pnpm build
-pnpm preview
+yarn build
+yarn preview
 ```
 
 ## Creating new tutorials
@@ -28,4 +32,4 @@ Tutorials live inside `content`. Each tutorial consists of a `README.md`, which
 
 ## Bumping tutorial dependencies
 
-Bump the dependency (for example Svelte) in both the root and the `content/common` `package.json`. In the root do `pnpm i` (to update `pnpm-lock.yaml`), in `content/common` do `npm i` (to update `package-lock.json`).
+Bump the dependency (for example `cow-sdk`) in both the root and the `content/common` `package.json`. In the root do `yarn` (to update `yarn.lock`), in `content/common` do `yarn` (to update `yarn.lock`).