Skip to content

Commit 244ec1c

Browse files
committed
docs: expand contributing.md
1 parent 3ec880e commit 244ec1c

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

CONTRIBUTING.md

+40
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,49 @@
11
# Contributing docs
22

3+
We welcome contributions!
4+
5+
## Getting started
6+
7+
### PNPM
8+
We use PNPM a package manager. To run the development server:
9+
10+
```sh
11+
pnpm install
12+
pnpm run dev
13+
```
14+
15+
The development server refreshes while editing code.
16+
17+
### Branches
18+
We use the convention of `{github-username}/{descriptive-title}` for branches.
19+
20+
### Linting
21+
We use ESLint for linting. You can run the following:
22+
```sh
23+
pnpm run lint
24+
```
25+
26+
## Depending on a change in gosling.js
27+
If your development relies on a change in gosling.js that has not been published yet, you can create your own packaged version of any branch by running the following on the desired branch in the gosling.js repo.
28+
```sh
29+
yarn
30+
yarn build
31+
yarn pack
32+
```
33+
You can then add this .tgz file with pnpm, or refer to it as follows:
34+
`"gosling.js": "file:<relative path to file>"`
35+
336
## Structure
437

538
This project consists of three components
639

40+
Gosling Component is created with a spec.
41+
GosRef refers to this GoslingComponent.
42+
The AltGoslingComponent subscribes to specResolved and rawData from GosRef
43+
44+
Whenever an event is published to specResolved, the AltGoslingComponent spec-map is created.
45+
46+
747
### 1: Set-up of alt-text tree data from Gosling spec
848

949
Input:

0 commit comments

Comments
 (0)