Skip to content

Commit e9decd9

Browse files
authored
Merge pull request #6 from sole/master
Migrated content from https://wiki.mozilla.org/DevTools/GetInvolved
2 parents 496e481 + f000c4e commit e9decd9

File tree

2 files changed

+36
-11
lines changed

2 files changed

+36
-11
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document needs lots of help, please update and improve it!
44

55
### Setup
66

7-
To get started you'll need to install the dependencies required using [yarn](https://yarnpkg.com/).
7+
To get started you'll need to install the dependencies required using [yarn](https://yarnpkg.com/) and [bundler](http://bundler.io/).
88

99
```bash
1010
yarn install

README.md

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

33
These are the tools provided by Firefox for developers to inspect Web code.
44

5-
This repository aims to provide a general overview of how the tools are built, who's working on them, and how to get involved. If you are looking for user support, there's [a whole area at MDN](https://developer.mozilla.org/en-US/docs/Tools) dedicated to it.
5+
This repository aims to provide a general overview of [how the tools are built](#working-on-the-code-and-contributing), [who](#people-and-modules) is working on them, and how to [get involved](#getting-in-touch).
6+
7+
If you are looking for user support, there's [a whole area at MDN](https://developer.mozilla.org/en-US/docs/Tools) dedicated to it.
68

79
We abide by our [code of conduct](https://dxr.mozilla.org/mozilla-central/source/devtools/CODE_OF_CONDUCT.md) and expect all contributors to do the same.
810

911
## Working on the code and contributing
1012

13+
The code for our tools is in two different locations, so if you want to work on a specific tool you will first need to locate where it is.
14+
1115
### `mozilla-central` vs `devtools-html`
1216

1317
The bulk of the code is hosted in the Firefox repository (we call it `mozilla-central`, often abbreviated as `m-c`), in the [devtools](https://dxr.mozilla.org/mozilla-central/source/devtools) folder. Development of newer pieces of the tools is happening in GitHub, on the [devtools-html](https://github.com/devtools-html/) organisation.
@@ -21,8 +25,7 @@ The repositories in `devtools-html` are more straightforward if you're used to *
2125
Since we have code in two different places, issues and bugs are to be found in two different places:
2226

2327
* For code in `m-c`: [http://firefox-dev.tools/](http://firefox-dev.tools/) which also lets you filter by good bugs for beginners.
24-
* For code in `devtools-html`: [this page](https://github.com/search?l=&q=org%3Adevtools-html+state%3Aopen&type=Issues) lists all the issues across the organisation.
25-
<!--TODO: ^^ add label:"help wanted" or similar to the query to get easy issues-->
28+
* For code in `devtools-html`: [this page](https://github.com/search?l=&q=org%3Adevtools-html+state%3Aopen&type=Issues) lists all the issues across the organisation and these are [available issues](https://github.com/search?l=&q=org%3Adevtools-html+state%3Aopen+label%3Aavailable&type=Issues) i.e. ready to be worked on.
2629

2730
## Documentation
2831

@@ -47,8 +50,28 @@ This is just a brief overview. For more detailed documentation:
4750

4851
The tools are broadly divided into panels. Each panel has one or more owners, who mostly work(s) on that panel and are the best people to ask if you have specific questions about the code.
4952

50-
<!-- TODO: from https://wiki.mozilla.org/DevTools/GetInvolved#Communication but update it -->
51-
<!-- TODO: * show organisations in github (doesn't work if people don't make their membership public) -->
53+
* about:debugging: jdescottes, ochameau
54+
* Animation Inspector: gl, pbro, daisuke
55+
* Canvas Debugger: `<unmaintained>`
56+
* Console: bgrins, nchevobbe
57+
* Debugger: jlast
58+
* Developer Toolbar: jwalker, mikeratcliffe
59+
* DOM: honza
60+
* Framework: Browser integration, toolbox and test infrastructure: jryans, bgrins, ochameau, honza
61+
* Inspector: gl, pbro, zer0, jdescottes, tromey
62+
* JSON Viewer: honza
63+
* Memory: gregtatum
64+
* Network Monitor: honza, rickychien, gasolin
65+
* Performance: gregtatum
66+
* Remote protocol and server infrastructure: jryans, ochameau
67+
* Responsive Design Mode: jryans, zer0
68+
* Scratchpad: jdescottes
69+
* Shader Editor: `<unmaintained>`
70+
* Style Editor: gl
71+
* Storage Inspector: mikeratcliffe
72+
* Themes: bgrins, ntim
73+
* Web Audio Editor: `<unmaintained>`
74+
* WebIDE: jryans, ochameau
5275

5376
## News and demos
5477

@@ -63,13 +86,15 @@ You're more than encouraged to help us talk about the tools by writing an articl
6386

6487
There are various ways to get in touch with us:
6588

66-
* To request features or report errors:
67-
* You can [file bugs in Mozilla's bugzilla](https://bugzilla.mozilla.org/enter_bug.cgi?product=Firefox&component=Developer%20Tools)
89+
* Bug reports or feature requests:
90+
* You can [file bugs in Mozilla's bugzilla](https://bugzilla.mozilla.org/enter_bug.cgi?product=Firefox&component=Developer%20Tools) (please respect the [etiquette](https://bugzilla.mozilla.org/page.cgi?id=etiquette.html)).
6891
* or under each repository in [devtools-html](https://github.com/devtools-html) for code in GitHub
69-
* We have [a section](https://discourse.mozilla-community.org/c/devtools) on the Mozilla forum. If you want to ask questions, this is a great way to get in touch with us and also ensuring that your question is visible to other people (and hopefully help them as well).
70-
* We also have a [mailing list](https://groups.google.com/forum/#!forum/mozilla.dev.developer-tools). For people who prefer mail to forums.
71-
* If you'd prefer to chat, there's a `#devtools` channel in `irc.mozilla.org`, but bear in mind that perhaps the person that could help you best is not online when you ask the question. For that reason, it might be better to use the forum or mailing list instead.
92+
* The [DevTools forum](https://discourse.mozilla-community.org/c/devtools) is a great way to get in touch with us and also ensure that your question is visible to other people (and hopefully help them as well).
93+
* [Mailing list](https://groups.google.com/forum/#!forum/mozilla.dev.developer-tools): for people who prefer mail to forums.
94+
* Team weekly video call: [Vidyo room DevTools](https://v.mozilla.com/flex.html?roomdirect.html&key=n9vJUD3L1vRMHKQC5OCNRT3UBjw), Tuesdays 9AM Pacific time.
95+
* IRC chat: `#devtools` channel in `irc.mozilla.org`, but bear in mind that perhaps the person that could help you best is not online when you ask the question. For that reason, it might be better to use the forum or mailing list instead.
7296
* Contributors to `debugger.html` also hold [periodic hangouts and have a slack channel](https://github.com/devtools-html/debugger.html#discussion).
97+
* Twitter: [@FirefoxDevTools](https://twitter.com/FirefoxDevTools).
7398

7499
## Processes
75100

0 commit comments

Comments
 (0)