Skip to content

Add overall philosophy to SAST direction

Connor Gilbert requested to merge connorgilbert/sast-philosophy into master

Why is this change being made?

💡 Provide a detailed answer to the question on why this change is being proposed, in accordance with our value of Transparency.

This page describes some of the context that is necessary for overall SAST product development. It arises in the context of a project related to the technical architecture of the SAST engine ( https://gitlab.com/groups/gitlab-org/-/epics/13552), but applies more broadly. Hence I don't believe it belongs in an epic.

I've included much of the "context" section because I've realized that some of this info is not clear to team members. We shouldn't leave this implicit/unstated, especially as we begin to take on large technical/architectural choices.

Where to put this?

I initially viewed this as too much content to fit into a direction page, which I believe should be an easy-to-read summary of where we are going. However, I don't have a better place in mind.

A lot of this could be refactored (essentially by replacing "GitLab SAST" with "Secure") and moved up to the stage direction perhaps, since I believe much of it applies across categories. This could be a useful next step.

I initially raised this MR as a standalone page in the internal handbook, but have moved it here with slight edits after discussion; see https://gitlab.com/gitlab-com/content-sites/internal-handbook/-/merge_requests/4519#note_1877424852.

Author and Reviewer Checklist

Please verify the check list and ensure to tick them off before the MR is merged.

  • Provided a concise title for this Merge Request (MR)
  • Added a description to this MR explaining the reasons for the proposed change, per say why, not just what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is SAFE
  • Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the Maintained by section on the page being edited
    • 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
    • The when to get approval handbook section explains the workflow in more detail
  • For transparency, share this MR with the audience that will be impacted.
    • Team: For changes that affect your direct team, share in your group Slack channel
    • Department: If the update affects your department, share the MR in your department Slack channel
    • Company: If the update affects all (or the majority of) GitLab team members, post an update in #whats-happening-at-gitlab linking to this MR
Edited by Connor Gilbert

Merge request reports