|
4 | 4 |
|
5 | 5 | This repository contains a couple of demos for core debugging stories, that need to be supported by DevTools to provide a fundamental, seamless debugging experience. |
6 | 6 |
|
| 7 | +## Creating demos (for crbugs) |
| 8 | + |
| 9 | +Demo projects and repros should be pushed to [ChromeDevTools/devtools-dbg-stories], |
| 10 | +and will then automatically be available on [devtools-dbg-stories.netlify.app]. |
| 11 | + |
| 12 | +When creating a repro for a [crbug](https://crbug.com), the recommended |
| 13 | +workflow is as follows: |
| 14 | + |
| 15 | +1. Create your own |
| 16 | + [fork](https://github.com/ChromeDevTools/devtools-dbg-stories/fork) on |
| 17 | + GitHub. |
| 18 | +2. Check out the fork locally. |
| 19 | + |
| 20 | + ``` |
| 21 | + git clone [email protected]:user/devtools-dbg-stories.git |
| 22 | + git remote add upstream https://github.com/ChromeDevTools/devtools-dbg-stories.git |
| 23 | + ``` |
| 24 | +
|
| 25 | + and create a feature branch. |
| 26 | +
|
| 27 | +3. Follow the steps for simple test cases. |
| 28 | +
|
| 29 | + ``` |
| 30 | + npm install |
| 31 | + npm start |
| 32 | + ``` |
| 33 | +
|
| 34 | + This will serve the examples at http://localhost:8000. |
| 35 | +
|
| 36 | +4. Create a new file `src/crbug-ID.html` (and other resources that are |
| 37 | + necessary), where `ID` refers to the bug number, and add a link to the |
| 38 | + `crbug-ID.html` file to the `src/index.html`. |
| 39 | +
|
| 40 | +5. Once you are happy with your repro, push it to your fork and send a pull |
| 41 | + request to the main repository. |
| 42 | +
|
7 | 43 | ## Usage |
8 | 44 |
|
9 | 45 | ### TypeScript Projects |
@@ -138,3 +174,6 @@ npm start |
138 | 174 | ``` |
139 | 175 |
|
140 | 176 | afterwards point your browser to [http://localhost:8000](http://localhost:8000). |
| 177 | + |
| 178 | + [ChromeDevTools/devtools-dbg-stories]: https://github.com/ChromeDevTools/devtools-dbg-stories |
| 179 | + [devtools-dbg-stories.netlify.app]: https://devtools-dbg-stories.netlify.app |
0 commit comments