Skip to content

Commit 9a644f2

Browse files
bmeurerDevtools-frontend LUCI CQ
authored andcommitted
[docs] Streamline guidance for externals.
The first-time contributor guidance was still heavily targeted at Googlers and didn't make a lot of sense this way for external contributors. Change-Id: Ic9c33042c75f633b6bacc5f63b8c10ba7e3750cd Fixed: 373257079 Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6239258 Commit-Queue: Benedikt Meurer <[email protected]> Reviewed-by: Changhao Han <[email protected]>
1 parent 12cf866 commit 9a644f2

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

docs/playbook.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,9 @@
22

33
This document serves as the Chrome DevTools Playbook and thereby provides guidance on how to work with Chrome DevTools, the types of Chrome DevTools support available, how you and your team can take advantage of that support to contribute features, and how to get help when in doubt of the type of support needed or if you need more support.
44

5-
## Instruction for Googlers
6-
7-
**Are you a Googler?** See [go/chrome-devtools/work-with-us](go/chrome-devtools/work-with-us) for additional information.
8-
95
## Getting Started
106

7+
* If you are a **Googler** see [go/chrome-devtools/work-with-us](go/chrome-devtools/work-with-us) for additional information.
118
* If you're a **first-time contributor** and would like some guidance to begin with, please jump to the [First Time Contributor](#first-time-devtools-contributor) section at the end of this document.
129
* If you are only looking for **DevTools documentations**, here is the [list](#devtools-documentation).
1310

@@ -164,9 +161,16 @@ Depending on your answers above *and/or* your current feature stage, you may nee
164161

165162
If you haven't worked with the Chrome DevTools team before, or if you're unsure where your feature fits, please follow the steps outlined below.
166163

167-
1. Ask yourself who will be using your features and what kind of tooling support they might need to ensure a smooth adoption of your feature. Try to think in terms of tasks and challenges developers may face, not UI elements.
168-
2. Write a short email to chrome-devtools@ with your best shot at answering those questions. It doesn't have to be perfect, and it is not a questionnaire you need to fill to satisfy some formal process. We are mostly interested in a positive end user experience and are willing to work with you together to achieve that.
169-
3. We will get back to you with some initial thoughts and probably will ask to have a quick VC (or in-person meeting if you are in DE-MUC) to align on the details. We will provide you with some information on how DevTools works, relevant to your case.
170-
4. We might need to write together a PRD or incorporate the developer story into the main feature PRD.
171-
5. Most likely we will ask you to book an office hours with our UXD to discuss your feature’s UX, so that developers have a consistent experience on DevTools. Complex features where developers have to be introduced to significant new capabilities may take multiple iterations. It’s important to get this step right.
172-
6. Depending on the details, we will probably ask you to help us get the information exposed over the [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/). We might also ask you to write a few straightforward CLs to implement the UI. Don't worry, we won't ask you to re-architect our code to accommodate your feature. We will also offer all the support you need along the way.
164+
1. Ask yourself who will be using your features and what kind of tooling support they might need to ensure a smooth adoption of your feature.
165+
Try to think in terms of tasks and challenges developers may face, not UI elements.
166+
2. Write a short email to devtools-dev@ with your best shot at answering those questions. It doesn't have to be perfect, and it is not a questionnaire
167+
you need to fill to satisfy some formal process. We are mostly interested in a positive end user experience and are willing to work with you together
168+
to achieve that.
169+
3. We will get back to you with some initial thoughts and might ask to formalize your ideas in a design document.
170+
4. Most likely we will ask you to book an office hours with our UXD to discuss your feature’s UX, so that developers have a consistent experience on
171+
DevTools. Complex features where developers have to be introduced to significant new capabilities may take multiple iterations. It’s important to
172+
get this step right.
173+
5. Depending on the details, we will probably ask you to help us get the information exposed over the
174+
[Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/). We might also ask you to write a few straightforward CLs to
175+
implement the UI. Don't worry, we won't ask you to re-architect our code to accommodate your feature. We will also offer all the support you
176+
need along the way.

0 commit comments

Comments
 (0)