Skip to content
This repository was archived by the owner on Jan 28, 2025. It is now read-only.

Commit 7cc90df

Browse files
docs: update contributing guide
1 parent eeb8858 commit 7cc90df

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,35 @@
33
### Getting started
44

55
1. First, [fork](https://help.github.com/en/articles/fork-a-repo) the repo to your own github account and clone it.
6-
2. Install dependencies: `npm install`
6+
2. Install dependencies: `npm install && npm run packages-install`
77

88
### Running the tests
99

1010
#### Unit tests
1111

12-
```bash
13-
npm test
14-
```
15-
16-
or in watch mode:
12+
I recommend testing the specific package in the monorepo that you are working with. For example:
1713

1814
```bash
19-
npm test -- --watch
15+
npm test -- lambda-at-edge/
2016
```
2117

22-
#### Integration
18+
In watch mode:
2319

2420
```bash
25-
npm run integration
21+
npm test -- --watch lambda-at-edge/
2622
```
2723

28-
#### Testing the plugin on a serverless application
24+
#### Deploying to AWS and testing your changes
2925

30-
Configure the app's `serverless.yml` to use your fork of the plugin as documented [here](https://serverless.com/framework/docs/providers/aws/guide/plugins#service-local-plugin).
26+
First, create your own test serverless component app and in the `serverless.yml` point the `component` field to your fork:
3127

3228
```yml
3329
# serverless.yml
34-
plugins:
35-
localPath: "path/to/serverless-plugin"
36-
modules:
37-
- index
30+
nextApp:
31+
component: "/path/to/your/fork/serverless-next.js/packages/serverless-component"
32+
inputs: ...
3833
```
34+
35+
Then from the app simply run `serverless` or `npx serverless` if you don't have the serverless cli installed.
36+
37+
Note: If you are working with a Typescript package make sure you build it (`npm run build`) before deploying ;)

0 commit comments

Comments
 (0)