-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for creating demos. (#74)
Add documentation for creating demos. Co-authored-by: Mathias Bynens <[email protected]>
- Loading branch information
1 parent
1b76ad7
commit 45889f7
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,6 +4,42 @@ | |
|
||
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. | ||
|
||
## Creating demos (for crbugs) | ||
|
||
Demo projects and repros should be pushed to [ChromeDevTools/devtools-dbg-stories], | ||
and will then automatically be available on [devtools-dbg-stories.netlify.app]. | ||
|
||
When creating a repro for a [crbug](https://crbug.com), the recommended | ||
workflow is as follows: | ||
|
||
1. Create your own | ||
[fork](https://github.com/ChromeDevTools/devtools-dbg-stories/fork) on | ||
GitHub. | ||
2. Check out the fork locally. | ||
|
||
``` | ||
git clone [email protected]:user/devtools-dbg-stories.git | ||
git remote add upstream https://github.com/ChromeDevTools/devtools-dbg-stories.git | ||
``` | ||
and create a feature branch. | ||
3. Follow the steps for simple test cases. | ||
``` | ||
npm install | ||
npm start | ||
``` | ||
This will serve the examples at http://localhost:8000. | ||
4. Create a new file `src/crbug-ID.html` (and other resources that are | ||
necessary), where `ID` refers to the bug number, and add a link to the | ||
`crbug-ID.html` file to the `src/index.html`. | ||
5. Once you are happy with your repro, push it to your fork and send a pull | ||
request to the main repository. | ||
## Usage | ||
### TypeScript Projects | ||
|
@@ -138,3 +174,6 @@ npm start | |
``` | ||
|
||
afterwards point your browser to [http://localhost:8000](http://localhost:8000). | ||
|
||
[ChromeDevTools/devtools-dbg-stories]: https://github.com/ChromeDevTools/devtools-dbg-stories | ||
[devtools-dbg-stories.netlify.app]: https://devtools-dbg-stories.netlify.app |