Improve comments

Author: devversion

tools/release/git/git-client.ts

@@ -3,7 +3,7 @@ import {spawnSync} from 'child_process';
 /**
  * Class that can be used to execute Git commands within a given project directory.
  *
- * Relying  on the working directory of the current process is not good because it's not
+ * Relying on the working directory of the current process is not good because it's not
  * guaranteed that the working directory is always the target project directory.
  */
 export class GitClient {

tools/release/stage-release.ts

@@ -7,6 +7,22 @@ import {promptForNewVersion} from './prompt/new-version-prompt';
 import {parseVersionName, Version} from './version-name/parse-version';
 import {getExpectedPublishBranch} from './version-name/publish-branch';
 
+/**
+ * Class that can be instantiated in order to stage a new release. The tasks requires user
+ * interaction/input through command line prompts.
+ *
+ * Staging a release involves the following the steps:
+ *
+ *  1) Prompt for release type (with version suggestion)
+ *  2) Prompt for version name if no suggestions has been selected
+ *  3) Assert that the proper publish branch is checked out (e.g. 6.4.x for patches)
+ *  4) Assert that there are no local changes which are uncommitted.
+ *  5) Assert that the local branch is up to date with the remote branch.
+ *  6) Creates a new branch for the release staging (release-stage/{VERSION})
+ *  7) Switches to the staging branch and updates the package.json
+ *  8) Waits for the user to continue (users can generate the changelog in the meanwhile)
+ *  9) Create a commit that includes all changes in the staging branch.
+ */
 class StageReleaseTask {
 
   /** Path to the project package JSON. */