Skip to content

Commit

Permalink
reorg contributions page
Browse files Browse the repository at this point in the history
  • Loading branch information
pelikhan committed Jun 23, 2023
1 parent ecfe5f4 commit 63ade1d
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 22 deletions.
2 changes: 1 addition & 1 deletion runtime/jacdac-c
45 changes: 24 additions & 21 deletions website/docs/contributing.mdx
Expand Up @@ -12,7 +12,14 @@ title: Contributing
- port firmware to other embedded platforms
- and many more!

## Repository structure
## Local development

The development requirement will vary (widely) depending
on which part of DeviceScript you want to work on.

Using Visual Studio Code is strongly recommended.

### Repository structure

This repository contains:

Expand All @@ -24,12 +31,6 @@ This repository contains:
- `vscode` - Visual Studio Code extension
- `website` - docusaurus documentation side

## Usage

The development requirement will vary (widely) depending on which part of DeviceScript you want to work on.

Using Visual Studio Code is strongly recommended.

### Compiler, runtime and command line

You can use the devcontainer to build. The instructions are tested for a Unix terminal.
Expand Down Expand Up @@ -92,7 +93,9 @@ If you bump minor, you need to also bump the firmware repos:
make bump
```

## Documenting/patching console output
## Contributions

### Documenting/patching console output

To add new substitions from console output message to pretty text + URL, do the following.

Expand All @@ -101,19 +104,7 @@ The hash of the H2 titles is the console log look up key (replacing - with space

loopback rx ovf --> Loopback buffer overflow (....#loopback-rx-ovf)

## Adding Builtin Packages

Generally, search for `@devicescript/gpio` within the workspace.
The main places that need updating is:

- this file, `website/docs/developer/packages.mdx`
- list in `plugin/src/plugin.ts`
- list in `devs/run-test/allcompile.ts`

After adding a new packages, run `yarn` at the top-level to update workspace links,
followed by the usual `yarn build`.

## Add Core JavaScript APIs
### Add Core JavaScript APIs

The DeviceScript [core js library](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects) is not complete; but it is possible to fill the gaps
as needed. The requests are tracked by the [core js issue label](https://github.com/microsoft/devicescript/issues?q=is%3Aissue+is%3Aopen+label%3A%22core+js%22).
Expand All @@ -126,6 +117,18 @@ If you want to add a new function:
- add test cases in the corresponding test file under `devs/run-tests`
- create a pull request and go!

### Adding Builtin Packages

Generally, search for `@devicescript/gpio` within the workspace.
The main places that need updating is:

- this file, `website/docs/developer/packages.mdx`
- list in `plugin/src/plugin.ts`
- list in `devs/run-test/allcompile.ts`

After adding a new packages, run `yarn` at the top-level to update workspace links,
followed by the usual `yarn build`.

## Legal

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Expand Down

0 comments on commit 63ade1d

Please sign in to comment.