Skip to content

Commit a23b3a5

Browse files
authored
Add CONTRIBUTING docs to DWDS (#1471)
1 parent 93afeec commit a23b3a5

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

dwds/CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Local Development
2+
3+
1. In the `/webdev` directory, run `pub global activate --source path webdev` (this only needs to be run once)
4+
2. Uncomment the dwds dependency override in `/webdev/webdev/pubspec.yaml`, then run `dart run build_runner build` from `/webdev/webdev` directory
5+
* *Note: You will have to comment and build, and then uncomment and build, each time you need to pick up new changes*
6+
2. From `/webdev/example`, run `webdev serve --debug --verbose` (Note: all options can be found by running `webdev help serve`)
7+
3. Type opt/alt-d in the browser. This is required to start the VM.
8+
4. [OPTIONAL] If you need to connect a locally running DevTools (instructions for running [here](https://github.com/flutter/devtools/blob/master/CONTRIBUTING.md )), then close the DevTools that automatically opened in the previous step. Copy and paste the debug URI (should be logged in your terminal) into the DevTools connection box.
9+
10+
### Note:
11+
If you get this error:
12+
13+
`The /webdev/webdev/pubspec.yaml file has changed since the /webdev/webdev/pubspec.lock file was generated, please run "dart pub get" again.`
14+
15+
You need to do the following:
16+
17+
* `rm webdev/webdev/pubspec.lock`
18+
* Then, from `/webdev/webdev` run `dart pub get`
19+
20+
## Release steps
21+
TODO

0 commit comments

Comments
 (0)