NO BUG - Update Marionette New Contributors guide and links; r=me
authorMaja Frydrychowicz <mjzffr@gmail.com>
Tue, 24 Apr 2018 15:55:00 -0400
changeset 471736 f864f16fdd38b52e30ce5d064b4f8c1c0fb8ae9e
parent 471735 257469dad07cd5b3855513268e0956ae620128af
child 471737 51c27d9d25eaca9db40ef561bd3f9cdab63bf9b0
push id1728
push userjlund@mozilla.com
push dateMon, 18 Jun 2018 21:12:27 +0000
treeherdermozilla-release@c296fde26f5f [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersme
milestone61.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
NO BUG - Update Marionette New Contributors guide and links; r=me
testing/marionette/doc/Contributing.md
testing/marionette/doc/NewContributors.md
testing/marionette/doc/index.rst
--- a/testing/marionette/doc/Contributing.md
+++ b/testing/marionette/doc/Contributing.md
@@ -1,11 +1,14 @@
 Contributing
 ============
 
+If you are new to open source or to Mozilla, you might like this
+[tutorial for new Marionette contributors](NewContributors.html).
+
 We are delighted that you want to help improve Marionette!
 ‘Marionette’ means different a few different things, depending
 on who you talk to, but the overall scope of the project involves
 these components:
 
   * [_Marionette_] is a Firefox remote protocol to communicate with,
     instrument, and control Gecko-based browsers such as Firefox
     and Fennec.  It is built in to Firefox and written in [XPCOM]
@@ -46,20 +49,20 @@ where to start.  Please don’t hesitate to [ask questions]!
 
 The canonical source code repository is [mozilla-central].  Bugs are
 filed in the `Testing :: Marionette` component on Bugzilla.  We also
 have a curated set of [good first bugs] you may consider attempting first.
 
 We have collected a lot of good advice for working on Marionette
 code in our [code style document], which we highly recommend you read.
 
-[ask questions]: #communication
-[reach out to us]: #communication
+[ask questions]: ./index.html#communication
+[reach out to us]: ./index.html#communication
 [mozilla-central]: https://searchfox.org/mozilla-central/source/testing/marionette/
-[good first bugs]: https://www.joshmatthews.net/bugsahoy/?automation=1&js=1
+[good first bugs]: https://www.joshmatthews.net/bugsahoy/?automation=1
 [code style document]: CodeStyle.html
 
 
 Next steps
 ----------
 
   * [Building](Building.html)
   * [Debugging](Debugging.html)
@@ -67,8 +70,9 @@ Next steps
   * [Patching](Patches.html)
 
 
 Other resources
 ---------------
 
   * [Code style](CodeStyle.html)
   * [Internals](internals/)
+  * [New Contributor Tutorial](NewContributors.html)
--- a/testing/marionette/doc/NewContributors.md
+++ b/testing/marionette/doc/NewContributors.md
@@ -1,47 +1,61 @@
 New contributors
 ================
 
 This page is aimed at people who are new to Mozilla and want to contribute
 to Mozilla source code related to Marionette Python tests, WebDriver
 spec tests and related test harnesses and tools. Mozilla has both
 git and Mercurial repositories, but this guide only describes Mercurial.
 
-If you run into issues, check out the Resources section below and
-**don't hesitate to ask questions**. :) The goal of these steps is
-to make sure you have the basics of your development environment
+If you run into issues or have doubts, check out the [Resources](#resources)
+section below and **don't hesitate to ask questions**. :) The goal of these
+steps is to make sure you have the basics of your development environment
 working. Once you do, we can get you started with working on an
 actual bug, yay!
 
 
 Accounts, communication
 -----------------------
 
   1. Set up [IRC].
 
-  2. Set up a [Bugzilla] account and a [Mozillians] profile.
+  2. Set up a [Bugzilla] account (and, if you like, a [Mozillians] profile).
      Please include your IRC nickname in both of these accounts
      so we can work with you more easily. For example, Eve Smith
      would set their Bugzilla name to "Eve Smith (:esmith)", where
      esmith is their IRC nick.
 
-  3. Join #ateam or #automation on irc.mozilla.org and introduce
-     yourself to the whole team and :maja_zf. We're nice, I promise.
+  3. Join #ateam on irc.mozilla.org and introduce
+     yourself to the team. :ato, :AutomatedTester, :maja_zf and :whimboo are all familiar with Marionette. We're nice, I promise, but we might not
+     answer right away (different time zones, time off, etc.).
+
+  4. When you want to ask a question on IRC, just go ahead an ask it even if
+     no one appears to be around/responding.
+     Provide lots of detail so that we have a better chance of helping you.
+     If you don't get an answer right away, check again in a few hours --
+     someone may have answered you in the mean time.
+
+  5. You can view IRC logs on [logbot] to check if anyone has answered your
+     question while you were offline.
+
+  6. If you're having trouble reaching us over IRC, you are welcome to send an
+     email to our [mailing list](index.html#communication) instead. It's a good
+     idea to include your IRC nick in your email message.
 
 [IRC]: https://developer.mozilla.org/en-US/docs/Mozilla/QA/Getting_Started_with_IRC
 [Bugzilla]: https://bugzilla.mozilla.org/
 [Mozillians]: https://mozillians.org/
-
+[logbot]: https://mozilla.logbot.info/ateam/
 
 Getting the code, running tests
 -------------------------------
 
-  1. Follow this tutorial to get a copy of Firefox source code and
-     build it: http://areweeveryoneyet.org/onramp/desktop.html
+  1. Follow this [tutorial](http://areweeveryoneyet.org/onramp/desktop.html)
+     to get a copy of Firefox source code and build Firefox for Desktop.
 
      If you're asked to run a 'bootstrap' script, choose the option
      "Firefox for Desktop Artifact Mode".  This significantly
      reduces the time it takes to build Firefox on your machine
      (from 30+ minutes to just 1-2 minutes).
 
   2. Check if you can run any marionette tests: Use [mach] to run
      [Marionette] unit tests against the Firefox binary you just
@@ -91,31 +105,27 @@ Getting the code, running tests
          you respond with 'No'.
 
 [mach]: https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/mach
 [Marionette]: ../README.md
 [Running Marionette tests]: https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/Running_Tests
 [latest results on Treeherder]: https://treeherder.mozilla.org/#/jobs?repo=mozilla-inbound&filter-job_type_symbol=Mn
 [Firefox Nightly]: https://nightly.mozilla.org/
 [virtualenv]: https://www.dabapps.com/blog/introduction-to-pip-and-virtualenv-python/
-[testing/marionette/client]: https://dxr.mozilla.org/mozilla-central/source/testing/marionette/client
-[testing/marionette/harness]: https://dxr.mozilla.org/mozilla-central/source/testing/marionette/harness
+[testing/marionette/client]: https://searchfox.org/mozilla-central/source/testing/marionette/client
+[testing/marionette/harness]: https://searchfox.org/mozilla-central/source/testing/marionette/harness
 
 
 Work on bugs and get code review
 --------------------------------
 
-Once you've completed the above basics, ask :maja_zf, :whimboo,
-or :ato in #ateam for a good first bug to work on.  (Or you can
-also take a look at the simple bugs listed on Bugs Ahoy.)
-
-If you're an Outreachy applicant and you find that we're offline or
-"afk" on IRC, feel free to send Maja an email instead: [myfirstname]
-at mozilla.com -- either way, be sure to tell me which bug you are
-interested in for your application!
+Once you've completed the above basics, find a bug to work on
+at [Bugs Ahoy](https://www.joshmatthews.net/bugsahoy/?automation=1). If
+you don't find any, ask :whimboo, :maja_zf
+or :ato in #ateam for a good first bug to work on.
 
 To work on the bug that is suggested to you and push a patch up
 for review, follow the [Firefox Workflow] in hg.
 
 After testing your code locally, you will push your patch to be
 reviewed in MozReview.  To set up MozReview, see this [configuration]
 page.  (Note: the only kind of account you need for MozReview is
 Bugzilla (not LDAP) and you can only use HTTPS, not SSH.)
@@ -125,38 +135,38 @@ Bugzilla (not LDAP) and you can only use
 
 
 Resources
 ---------
 
   * Sometimes (often?) documentation is out-of-date.  If something looks
     off, do ask us for help!
 
-  * Search Mozilla's hg repositories with [DXR].
+  * This document provides a one-track, simple flow for getting
+    started with Marionette Test Runner development.
+    The general guide to all Marionette development is at [Contributing](Contributing.html)
 
-  * Helpful [guide for new contributors].  This is a good general
+  * Search Mozilla's hg repositories with [searchfox].
+
+  * Another [guide for new contributors].  It has not been updated in a long
+    time but it's a good general
     resource if you ever get stuck on something.  The most relevant
     sections to you are about Bugzilla, Mercurial, Python and the
     Development Process.
 
   * [Mercurial for Mozillians]
 
-  * More general resources are available in this little [guide] I wrote
+  * More general resources are available in this little [guide] :maja_zf wrote
     in 2015 to help a student get started with open source contributions.
 
     * Textbook about general open source practices: [Practical
       Open Source Software Exploration]
 
-  * This guide provides a one-track, simple flow for getting
-    started with Marionette Test Runner development.
-    The general guide to all Marionette development is at
-    https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/Developer_setup.
-
   * If you'd rather use git instead of hg, see git workflow for
     Gecko development and/or [this blog post by :ato].
 
-[DXR]: https://dxr.mozilla.org/
+[searchfox]: https://searchfox.org/mozilla-central/source/testing/marionette/
 [guide for new contributors]: https://ateam-bootcamp.readthedocs.org/en/latest/guide/index.html#new-contributor-guide
 [Mercurial for Mozillians]: https://mozilla-version-control-tools.readthedocs.org/en/latest/hgmozilla/index.html
 [guide]: https://gist.github.com/mjzffr/d2adef328a416081f543
 [Practical Open Source Software Exploration]: https://quaid.fedorapeople.org/TOS/Practical_Open_Source_Software_Exploration/html/index.html
 [git workflow for Gecko development]: https://github.com/glandium/git-cinnabar/wiki/Mozilla:-A-git-workflow-for-Gecko-development
 [this blog post by :ato]: https://sny.no/2016/03/geckogit
--- a/testing/marionette/doc/index.rst
+++ b/testing/marionette/doc/index.rst
@@ -57,13 +57,13 @@ Bugs are tracked in the `Testing :: Mari
 
 Communication
 =============
 
 The mailing list for Marionette discussion is
 tools-marionette@lists.mozilla.org (`subscribe`_, `archive`_).
 
 If you prefer real-time chat, there is often someone in the #ateam IRC
-channel on irc.mozilla.org.  Don’t ask if you can ask a question, just
-ask, and please wait for an answer as we might not be in your timezone.
+channel on irc.mozilla.org.  Don’t ask if you may ask a question; just go ahead
+and ask, and please wait for an answer as we might not be in your timezone.
 
 .. _subscribe: https://lists.mozilla.org/listinfo/tools-marionette
 .. _archive: https://groups.google.com/group/mozilla.tools.marionette