Skip to content

Commit 324f1ea

Browse files
committed
add contributing and fix release yml
1 parent c829779 commit 324f1ea

2 files changed

Lines changed: 13 additions & 1 deletion

File tree

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: release
22

33
on:
44
release:
5-
- types: [released]
5+
types: [published]
66

77
jobs:
88
docker:

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Running / developing locally
2+
3+
### Prerequisites
4+
5+
You _must_ follow the steps for node-canvas outlined here: https://www.npmjs.com/package/canvas.
6+
7+
### Project structure
8+
9+
This repo uses npm workspaces and is split into two main top level folders:
10+
11+
- `./apps` - Contains the two 'applications', `frontend` and `backend`.
12+
- `./packages` - Contains all of the packages which can be used by both applications.

0 commit comments

Comments
 (0)