Sylvestre Ledru
09ed896db1
devtools/docs/contributor/contributing.md described getting code into the repository as three links: find-bugs.md, fixing-bugs.md and making-prs.md, under a ./contributing/ directory that does not exist. They built to href="#./contributing/find-bugs.md", so the whole "Help with code" path silently went nowhere. Sphinx does not warn about it because a "#" fragment looks like a local anchor. Point the three steps at the general documentation instead, which is what contributor/index.md already tells readers to do: it says this section "only contains technical information specific to Firefox DevTools". Note that DevTools patches go to #devtools-reviewers. bugs-issues.md still split bugs across mozilla-central and the devtools-html GitHub organisation. All DevTools code lives in mozilla-central now, so drop the dead organisation search links and point at filing-good-bugs for how to write an actionable report. For bugs to work on, point at the DevTools project on Codetribute rather than firefox-dev.tools, which no longer lists bugs itself. Differential Revision: https://phabricator.services.mozilla.com/D318454
4.0 KiB
Contributing to DevTools
Thank you for taking the time to contribute! There are several areas where you can help: code, UX, bugs, talking about the DevTools, etc...
👉 Code of conduct 👈
We strive for collaboration with mutual respect for each other. Mozilla also has a set of participation guidelines which goes into greater detail specific to Mozilla employees and contributors.
Please read the two links above before getting involved. Contributions that don't abide by the code of conduct and participation guidelines will be rejected.
Help with code
Whether you're an external contributor or a Mozilla employee, the process to get your code into the repository is essentially the same:
- You find a bug to work on (note: we use bugs to track 'broken' things, new features and even discussions). See {doc}
/contributing/filing-good-bugsand DevTools bugs and issue trackers. - Work on the bug, then {ref}
write and submit a patch <write-a-patch>. - {ref}
Request a review <Getting reviews>for your code. DevTools patches go to#devtools-reviewers. - Land the code in the repository.
- And you've contributed—well done 😀
The steps above are the same for every part of Firefox, so they are documented
once in {ref}Working on Firefox <working-on-firefox>. This page and the rest
of this section only cover what is specific to DevTools.
Help with design and UX
If you're more interested in user experience (think: wireframes, workflows, navigations... and not necessarily implementation details), please have a look at the UX repository—our friendly designers will be more than happy to welcome you onboard. You can also have a look at the issues they are considering right now, to get an idea of how it works.
Help with BUGS! 🐛🐞
Not less importantly, we also love when people file bugs. They help us a lot and are very valuable (specially when they come with reproducible steps, e.g. in the case of crashes or malfunctions). Here is a short {doc}guide on how to file good bugs </contributing/filing-good-bugs> if you've never done it before (or if you need a reminder).
Another thing that is super valuable is reproducing bugs (to validate they're happening in more than one environment), and also completing bugs, i.e. ensuring the bug has steps to reproduce, a test case, etc, as {doc}mentioned on the guide </contributing/filing-good-bugs>. This saves time for the person(s) who will work on the bug, as then they can jump straight to fixing or implementing whatever is needed, instead of doing research work. If you can do any of these for a given bug, add a comment with the additional data that you found out.
Likewise, if you think that a bug is solved, because you can't reproduce it and doesn't happen any more, this is also useful to know. We can always do with closing more bugs, so please leave a comment detailing as much information as you can provide 😀
Talking about the tools
We really love when people talk about our work. Be it in a blog post, or in your favourite social media network, or user group, conference, you name it! We'd love to read/watch your article/talk, so please get in touch if you do.
Answering other people's questions in our Discourse forum or developer mailing list is also helpful.
Other areas
The above is not a comprehensive list; if you think you can help some other way that is not here, feel free to do it!
Whatever you choose to do, thank you so much for helping us ❤️