Skip to content

Option to add README when creating a project

When creating new projects using the UI, it is convenient to immediately create a README so that the Git repository can is initialized, has a default branch and can be cloned. Until the first file is created it can't be cloned.

Additionally, in some orgs there are only a few people with permissions to create projects, and most users have developer permissions. If a project is created for a developer, but the master branch doesn't exist, because the first branch pushed will become the default branch and this is protected by default in most instances, the developer will not be able to push a feature branch (since it will be consider the default and thus protected). Providing an easy way for users create a readme when creating a project will help prevent this problem.

Original Proposal ### Proposal

Add a new option to create the project with a README.md in the master branch.

The option should be unchecked by default.

If checked by the user, when the project is created:

  • create master branch
  • create first commit Initial commit which should add README.md with the content # <project name>\n

new-project-readme

Design

add-readme-checkbox

  • The checkbox will be unchecked by default
  • If the user checks the feature
    • create master branch
    • create first commit Initial commit which should add README.md with the content # <project name>\n<project description>

Copy

Initialize repository with a README
Allows you to immediately clone this project’s repository. Skip this if you plan to import an existing repository.

Future improvements

Show generators for .gitlab-ci.yml, LICENSE and .gitignore, ideally with support for template repositories

Links

Edited by Jeethu Karthik