summaryrefslogtreecommitdiffstats
path: root/devtools/docs/contributor/index.rst
blob: 4f29f27bb5a7f18f26a36ef2900d2e207610d453 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
.. toctree::
   :name: devtools-contributor-doc

=================================
Firefox DevTools Contributor Docs
=================================

This is a guide to working on the code for Firefox Developer Tools. If you're looking for help with using the tools, see the `user docs </devtools-user>`_. For other ways to get involved, check out our `community site <https://firefox-dev.tools/>`__.


Getting Started
===============
.. toctree::
   :maxdepth: 1

   Getting Started <getting-started/README.md>
   Get a Bugzilla account <getting-started/bugzilla.md>
   Create a development profile <getting-started/development-profiles.md>


Contributing
============
.. toctree::
   :maxdepth: 1

   Contributing <contributing.md>
   Find bugs to work on <contributing/find-bugs.md>
   How to fix a bug <contributing/fixing-bugs.md>
   Code reviews <contributing/code-reviews.md>
   Landing code <contributing/landing-code.md>
   Leveling up <https://firefox-source-docs.mozilla.org/contributing/levelling-up.html>
   Coding standards <contributing/coding-standards.md>
   Filing good bugs <https://firefox-source-docs.mozilla.org/contributing/filing-good-bugs.html>
   Investigating performance issues <contributing/performance.md>
   Writing efficient React code <contributing/react-performance-tips.md>


Recurring tasks
===============
.. toctree::
   :maxdepth: 1

   Release tasks<release.md>
   Performance sheriffing<performance-sheriffing.md>


Automated tests
===============
.. toctree::
   :maxdepth: 1

   Automated tests <tests/README.md>
   xpcshell <tests/xpcshell.md>
   Chrome mochitests <tests/mochitest-chrome.md>
   DevTools mochitests <tests/mochitest-devtools.md>
   Node tests <tests/node-tests.md>
   Memory Allocation tests </devtools/tests/memory/index.md>
   Writing tests <tests/writing-tests.md>
   Debugging intermittent failures <tests/debugging-intermittents.md>
   Performance tests overview<tests/performance-tests-overview.md>
   DAMP Performance tests <tests/performance-tests-damp.md>
   Writing a new test <tests/writing-perf-tests.md>
   Example <tests/writing-perf-tests-example.md>
   Advanced tips <tests/writing-perf-tests-tips.md>

Files and directories
=====================
.. toctree::
   :maxdepth: 1

   Files and directories <files/README.md>
   Adding New Files <files/adding-files.md>


Tool Architectures
==================
.. toctree::
   :maxdepth: 1

   Inspector Panel Architecture <tools/inspector-panel.md>
   Inspector Highlighters <tools/highlighters.md>
   Memory <tools/memory-panel.md>
   Debugger <tools/debugger-panel.md>
   Responsive Design Mode <tools/responsive-design-mode.md>
   Console <tools/console-panel.md>
   Network </devtools/netmonitor/architecture.md>
   Storage <tools/storage.md>


Frontend
========
.. toctree::
   :maxdepth: 1

  Panel SVGs <frontend/svgs.md>
  React <frontend/react.md>
  React Guidelines <frontend/react-guidelines.md>
  Redux <frontend/redux.md>
  Redux Guidelines <frontend/redux-guidelines.md>
  Telemetry <frontend/telemetry.md>
  Content Security Policy <frontend/csp.md>


Backend
=======
.. toctree::
   :maxdepth: 1

   Remote Debugging Protocol <backend/protocol.md>
   Backend Overview <backend/watcher-architecture.md>
   Client API <backend/client-api.md>
   Debugger API <backend/debugger-api.md>
   Backward Compatibility <backend/backward-compatibility.md>
   Actors Organization <backend/actor-hierarchy.md>
   Writing Actors With protocol.js <backend/protocol.js.md>
   Registering A New Actor <backend/actor-registration.md>
   Actor Best Practices <backend/actor-best-practices.md>

Preferences
===========
.. toctree::
   :maxdepth: 1

   Preferences <preferences.md>