Skip to content

Commit

Permalink
Change the Getting Started guide to a Walk-through
Browse files Browse the repository at this point in the history
Summary:
Make various changes to the Getting Started guide to convert it to a
Phabricator walk-through.

Test Plan: `make html`, see repo README for instructions

Reviewers: mcote

Reviewed By: mcote

Bug #: 1459702

Differential Revision: https://phabricator.services.mozilla.com/D1160
  • Loading branch information
mars-f committed May 8, 2018
1 parent 5c2de6b commit 571ea93
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 18 deletions.
2 changes: 1 addition & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Table of Contents
.. toctree::
:maxdepth: 2

getting-started
phabricator-user
walkthrough
mozreview-migration-guide
contributing

Expand Down
30 changes: 13 additions & 17 deletions getting-started.rst → walkthrough.rst
Original file line number Diff line number Diff line change
@@ -1,33 +1,29 @@
************
Introduction
************
*********************************
Phabricator Workflow Walk-through
*********************************

Mercurial Setup
===============

.. TODO link to the main phab doc
**IMPORTANT:** Make sure you have :ref:`set up Phabricator and Arcanist <quick-start>` before proceeding!

Multi-Head vs. bookmarks
========================

While some developers use bookmarks/etc to track changes, it's possible to just create a new "head", which essentially means "just start coding off tip and commit". The ``hg wip`` alias provides a view of the repository that allows for keeping track of the work.

.. FIXME: wording
.. FIXME: include link to https://mozilla-version-control-tools.readthedocs.io/en/latest/hgmozilla/workflows.html#to-label-or-not-to-label ?
For this guide we will use just repository heads: no bookmarks or labels.

(If you want to dig deeper into the "to label or not to label" discussion, see `this document <https://mozilla-version-control-tools.readthedocs.io/en/latest/hgmozilla/workflows.html#to-label-or-not-to-label>`_)

***************
Getting Started
***************

Style 1: One review per head
============================
Style 1: One repository head per review
=======================================

In this style we use GitHub-style fix-up commits under a single head. The fix-ups will be squashed into a single commit before landing.
In this style we use GitHub-style fix-up commits under a single repository head. The fix-ups will be squashed into a single commit before landing.

We'll use:

* One review
* Multiple fix-up commits under one head
* One repository head
* One review request per head
* ``hg commit`` to add fix-up commits to the head

Fixing the code
---------------
Expand Down

0 comments on commit 571ea93

Please sign in to comment.