Skip to content

Commit

Permalink
Merge pull request #9 from rosborne132/add-pr-template
Browse files Browse the repository at this point in the history
update README.md and add github pr template
  • Loading branch information
JeanChristopheMorinPerso committed Apr 21, 2023
2 parents 6635e26 + dd716b8 commit b809259
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 7 deletions.
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Summary of changes

Fixes #123.

Describe the reason for the change.

Add a list of changes, and note any that might need special attention during review. Help us understand what this pull request is changing and why it's needed.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Javascript bindings.

## Prerequisites

- Node 18 or higher ([https://nodejs.org/en/download](https://nodejs.org/en/download))
- Node 17 or higher ([https://nodejs.org/en/download](https://nodejs.org/en/download))

## Getting Started
Follow these steps to set up and run the JS Bindings project on your local machine:
Expand All @@ -29,12 +29,22 @@ make build
make install
```

Right now, files will be installed in the `./install` directory. This is hardcoded.

5. Run unit tests
```bash
npm run test
```

[Jest](https://jestjs.io/) is used as a the test runner.
Additional arguments can be passed to Jest like this: `npm test -- <additional arguments>`.

## State of the project

This is still a work in progress for now, but the base is there. That is:

* `SerializableObject`, `SerializableObjectWithMetadata`, ability to subclass them and
register custom schemas from Javascripts.
register custom schemas from Javascript.
* `Composable`, `Marker`, `Clip` (partial) and `SerializableCollection` (partial).
* Serialization and deserialization is mostly working, though it needs more work to
cover everything.
Expand All @@ -49,11 +59,6 @@ This is still a work in progress for now, but the base is there. That is:
* Tests live in the [tests](./tests) directory.
* Tests are run automatically on every push using GitHub Actions.

Right now, files will be installed in the `./install` directory. This is hardcoded.

To run the tests, run `npm test`. [Jest](https://jestjs.io/) is used as a the test runner.
Additional arguments can be passed to Jest like this: `npm test -- <additional arguments>`.

## TODO

Most TODOs are documented in the code. Search for `TODO:` and you will find everything that
Expand Down

0 comments on commit b809259

Please sign in to comment.