Skip to content

Add README file when creating new Security Policy Project

Why are we doing this work

Currently when we are creating new project we are not adding any README file that will explain why this project exists and how you can contribute to Security Policies (!64589 (comment 608464516)).

In this issue we want to focus on that: add README file with relevant information related to Security Policies:

  • link to the documentation.
  • how to contribute,
  • approval process

Relevant links

Non-functional requirements

  • [-] Documentation:
  • [-] Feature flag:
  • [-] Performance:
  • [-] Testing:

Implementation plan

  • backend Extend Projects::CreateService to support providing README content in the arguments and use it to create new commit with README file (modify create_readme method),
  • backend use new method in mutation to create new policy project,
  • documentation Prepare README template file with relevant information
  • documentation Mention about the protected branch access levels for security policy project which would override group level default branch protection: !65830 (comment 627168326)
Edited by Alan (Maciej) Paruszewski