Skip to content

Add improved readme content for all new projects

What does this MR do and why?

This resolves the new_project_readme_content experiment into a feature.

The result of the experiment is that more advanced readme content improves engagement with several aspects that are documented within it, so we've extracted that logic into a new service that can be used in the future to consolidate customized readme contents based on the project type and features included in it as it's being created.

Screenshots or screen recordings

There's not really a screenshot as it's markdown, but you can review the new default readme template, as that's the most relevant public facing content.

How to set up and validate locally

  1. Create a new blank project and ensure the "Initialize repository with a README" checkbox is checked (checked is the default).

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports