Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
metonym committed Apr 11, 2024
1 parent 35136ea commit 0a24fcc
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,24 +31,24 @@ yarn install

### Unit tests

Ensure the unit tests pass by running `yarn test:unit`.
Ensure the unit tests pass by running `yarn test`.

### Integration tests
### End-to-end (e2e) tests

Because this library is written in TypeScript, it must be transpiled to JavaScript before it can be used by integration tests in the `integration` folder.
Because this library is written in TypeScript, it must be transpiled to JavaScript before it can be used by e2e tests in the `tests/e2e` folder.

Run `yarn build` to build the library. The transpiled JavaScript code is emitted to the `lib` folder.

To build the library in watch mode, run `yarn build:watch`.
To build the library in watch mode, run `yarn build -w`.

### Continuous Integration

The `yarn prepack` command is executed in Travis CI.
This project uses GitHub Actions for continuous integration (CI).

It does the following:

1. Build the library
2. Run unit/svelte-check/integration tests in parallel
2. Run unit tests

The CI should pass if no unexpected errors occur.

Expand All @@ -60,8 +60,8 @@ Before submitting a pull request, make sure your fork is up to date with the lat

```sh
git fetch upstream
git checkout master
git merge upstream/master
git checkout main
git merge upstream/main
```

### Submit a PR
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,15 +188,15 @@ sveld({
})
```

The [integration](integration) folder contains example set-ups:

- [single-export](integration/single-export): library that exports one component
- [single-export-default-only](integration/single-export-default-only): library that exports one component using the concise `export { default } ...` syntax
- [multi-export](integration/multi-export): multi-component library without JSDoc annotations (types are inferred)
- [multi-export-typed](integration/multi-export-typed): multi-component library with JSDoc annotations
- [multi-export-typed-ts-only](integration/multi-export-typed-ts-only): multi-component library that only generates TS definitions
- [glob](integration/glob): library that uses the glob strategy to collect/analyze \*.svelte files
- [carbon](integration/carbon): full `carbon-components-svelte` example
The [tests/e2e](tests/e2e) folder contains example set-ups:

- [single-export](tests/e2e/single-export): library that exports one component
- [single-export-default-only](tests/e2e/single-export-default-only): library that exports one component using the concise `export { default } ...` syntax
- [multi-export](tests/e2e/multi-export): multi-component library without JSDoc annotations (types are inferred)
- [multi-export-typed](tests/e2e/multi-export-typed): multi-component library with JSDoc annotations
- [multi-export-typed-ts-only](tests/e2e/multi-export-typed-ts-only): multi-component library that only generates TS definitions
- [glob](tests/e2e/glob): library that uses the glob strategy to collect/analyze \*.svelte files
- [carbon](tests/e2e/carbon): full `carbon-components-svelte` example

### CLI

Expand Down

0 comments on commit 0a24fcc

Please sign in to comment.