Skip to content

Handbook Update: "Styling branch names"

Sara Kassabian requested to merge 6781-blog-style-guide-handbook-update-styling-branch-names into master

Why is this change being made?

After some feedback from the technical writing team, I learned that the best practice is to style branch names in backticks so it reads branch-name. I wanted to update our Blog Style Guide so that way we remember to style branch names in backticks as opposed to using quotation marks.

Author Checklist

  • Correct MR template applied (e.g blog post)
  • Provided a concise title for the MR
  • Added a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what
  • Assign this change to the correct DRI
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to your manager.
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies.
    • If the changes relate to any part of the project other than updates to content and/or data files please make sure to ping @gl-static-site-editor in a comment for a review and merge. For example changes to .gitlab-ci.yml, JavaScript/CSS/Ruby code or the layout files.

For help with failing pipelines reach out in #mr-buddies in Slack

Closes #6781 (closed)

Edited by Sara Kassabian

Merge request reports