mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-09-28 13:13:37 +08:00
Benedikt Meurer
9a644f2be4
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 <bmeurer@chromium.org> Reviewed-by: Changhao Han <changhaohan@chromium.org>
Chromium DevTools docs
This directory contains Chrome DevTools project documentation in Gitiles-flavored Markdown. It is automatically rendered by Gitiles.
If you add new documents, please also add a link to them in the Document Index below.
[TOC]
Chromium DevTools Playbook (aka Work With Us)
- See the playbook for step-by-step instructions on how to work with Chromium DevTools to implement your idea.
Document Index
Design Documents
- See the shared Design Documents folder in the Chromium drive.
General Development
- Get the Code
- Contribution Guide
- UX Style Guide
- Testing Guide
- Cookbook
- Visual logging in DevTools
- Style Guides
Architectural Documentation
Chromium
Checklists
- DevTools UI feature checklist
- DevTools support checklist for Blink Intents
- DevTools support checklist for JavaScript features
- DevTools support checklist for WebAssembly features
Policies
Useful Commands
git cl format --js
Formats all code using clang-format.
npm run check
Runs all static analysis checks on DevTools code.
Creating Documentation
Guidelines
- See the Chromium Documentation Guidelines and the Chromium Documentation Best Practices.
- Markdown documents must follow the Markdown style guide.
Previewing changes
Locally using md_browser
Assuming that /path/to/src contains a chromium checkout, you can run:
# in devtools-frontend checkout
/path/to/src/tools/md_browser/md_browser.py --directory $PWD
and preview the result by opening http://localhost:8080/docs/README.md in your browser. This is only an estimate. The gitiles view may differ.
Online with Gerrit's links to gitiles
- Upload a patch to gerrit, or receive a review request. e.g. https://chromium-review.googlesource.com/c/3362532
- View a specific .md file. e.g. https://chromium-review.googlesource.com/c/3362532/2/docs/README.md
- You will see something like
at the top left of the page. Click on the second "preview" link to open the preview for the current patch set.
This gitiles view is the authoritative view, exactly the same as will be used when committed.