👍🎉 First off, thanks for taking the time to contribute! 🎉👍
We respect your time and want to help you make the most of it as you check out this project.
What should I know before I get started?
This debugger project is part of a larger initiative called devtools.html. The devtools.html project claims its origin from a demo for a Mozilla (Dec 2016) work week in Orlando, FL USA. The code for that demo can be found on Github under @joewalker/devtools.html where the team worked under a tight deadline to provide a proof of concept of the Firefox developer tools running in pure HTML; even outside of Firefox.
From the original demo the devtools.html project has progressed quite a bit. To learn more about it please read the devtools.html proposal document and take a look at the devtools.html meta bug for tracking progress.
The medium to long term goal of this project is to land within Firefox. If you're looking to work directly on the DevTools project which ships developer tools for Firefox and Firefox Developer Edition in the meantime you can find more information on the Mozilla wiki DevTools / Get Involved.
Because of our unstable nature at this point bug fixing is not a top priority for the team. If you find an issue with the code please do file an issue. We'll do our best to review the issue but a fix may be coming with future changes and so the issue may be closed out to wait until a future fix comes along.
Because of the experimental nature of this project we're not able to review all enhancement suggestions at this point. However if you have a suggestion you feel is important for the team to be aware of please create an issue, tag it with the enhancement label and we will attempt to respond.
Still interested in contributing even though this is a fast moving experiment? Unsure where to begin contributing? You can start by looking through the Beginner Bug issues:
- Beginner Bug - issues which should only require a few lines of code, and a test or two.
To begin your work make sure you follow these steps:
- Fork this project
- Create a branch to start your work
git checkout -b feature-branch - Commit your work
- Create a pull request
- Include screenshots and animated GIFs in your pull request whenever possible.
- List any steps necessary to trigger the feature you've created or bug you are fixing
- Always run the tests locally before creating your PR
- Request review from @jasonLaster or @jlongster by mentioning their names in the PR
Your code must pass tests to be merged in. Your tests should pass locally before you create a PR and the CI should run an automated test that also passes.
To test your changes run the command:
$ npm run test
We use eslint to maintain our JavaScript styles. The .eslintrc file contains our style definitions, please adhere to those styles when making changes.
To test your changes against the linter run the command:
$ npm run lint-js
We use Stylelint to maintain our CSS styles. The .stylelintrc file contains the style definitions, please adhere to those styles when making changes.
To test your changes against the linter run the command:
$ npm run lint-css