We have implemented Gated Checkins (branch policies) on Master,
Dev-Master, and the Client branches. No one, not even the senior team
members, can commit directly to those branches anymore. A separate
branch must be created and a Pull Request made via VSTS to get your
updates pushed into Dev-Master. Once a Pull Request is made, the
appropriate reviewers will review and validate the code being submitted
and Approve or Reject the Pull Request. If we Reject it, we will be
providing reasons why in the Discussion on the Request.
When you go to make your own branch to work in, please follow this
standardized naming convention:
for example:
Client branches should be named:
for example:
You will not perform any work in the Client branches as they are also
locked. In rare circumstances, a branch off of the Client branch may be
approved to insert work that cannot be applied to Core CEF.
Documentation for Developer and End User audiences will be completed on
the MadCap Flare software for publishing the documentation source to PDF
and online user documentation with minimal time and effort after
authorship. Flare allows for multiple output types, and tracks of
publishing using conditionals to steer the audience type and targets to
steer the publication to the web or print documentation environment for
the end user. For Clarity's purpose, the tracks will be per Version
number and the conditionals will be used for delivering content to the
audience types.