DevTools/Hacking: Difference between revisions

Jump to navigation Jump to search

DevTools/Hacking (view source)

Revision as of 12:53, 31 May 2017

3,032 bytes removed ,  31 May 2017
update with new location
(→‎Finding documentation: update with new location)
(update with new location)
Line 1: Line 1:
Want to work on [[DevTools|Firefox Developer Tools]]?  You've come to the right place!  If you want more information about contributing, check out our guide for [[DevTools/GetInvolved|getting involved]].
The contents of this section have been moved to


= Building, running, updating and rebuilding =
https://dxr.mozilla.org/mozilla-central/source/devtools/docs/contributing.md
 
and
These instructions have been moved to https://devtools-html.github.io/docs/building.html
https://dxr.mozilla.org/mozilla-central/source/devtools/docs/contributing
 
= Configuring your dev profile =
 
These instructions have been moved to https://devtools-html.github.io/docs/building-development-profile.html
 
= Developer Tools Directories Overview =
 
This has been migrated to https://dxr.mozilla.org/mozilla-central/source/devtools/docs/files/README.md
 
= DevTools Automated Tests =
 
The contents of this section have been moved to https://dxr.mozilla.org/mozilla-central/source/devtools/docs/tests/README.md and other files in https://dxr.mozilla.org/mozilla-central/source/devtools/docs/tests/
 
= Finding documentation =
 
The contents of this section are now in https://dxr.mozilla.org/mozilla-central/source/devtools/docs/getting-started/README.md
 
= Making and Submitting a Patch =
 
Before you make any changes, read [http://mozilla-version-control-tools.readthedocs.org/en/latest/hgmozilla/index.html the documentation on how to use Mozilla's version control].
 
Before you submit a patch, you should read our [[DevTools/CodingStandards|Coding Standards]] and run [https://wiki.mozilla.org/DevTools/CodingStandards#JS_linting_with_ESLint ESLint] to validate your code changes (to avoid loosing time during code reviews with formatting details for instance). In general, try to be File Consistent. For new files, follow the standards.
 
Once you have a patch file, add it as an attachment to the Bugzilla ticket you are working on and add the '''feedback?''' or '''review?''' flag depending on if you just want feedback and confirmation you're doing the right thing or if you think the patch is ready to land respectively. Read more about [https://developer.mozilla.org/en-US/docs/Developer_Guide/How_to_Submit_a_Patch how to submit a patch and the Bugzilla review cycle here].
 
You can also take a look at the [[DevTools/Code Review Checklist]] as it contains a list of checks that your reviewer is likely to go over when reviewing your code.
 
= Coding Standards =
 
DevTools has some coding standards that your changes should follow:
 
* [[DevTools/CodingStandards|JavaScript coding standards]]
* [[DevTools/CSSTips|CSS tips]]
* [https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/SVG_Guidelines SVG Best practices] and [https://dxr.mozilla.org/mozilla-central/source/devtools/docs/svgs.md guidelines for creating new DevTools SVGs]
 
= Potential Pitfalls =
 
Today there are a few techniques and conventions we use that can be confusing, especially when you first start working with the code base.  We hope to improve these with time to make things easier for everyone, but for now this [https://public.etherpad-mozilla.org/p/devtools-intro-pitfalls etherpad] might be a helpful set of notes if you are having trouble.  If you find new pitfalls that aren't listed there, feel free to add your own entries, so we know to address them.  Also, please come talk to us in #devtools on IRC, as that might be the fastest path to solving the issue.
Sole
Confirmed users
100

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/1172242"

Navigation menu