Creating a new repository

Introduction

This page describes what steps to take when creating new repositories.

Declare a maintainer

Every repository should have at least one maintainer. The maintainer is responsible for the repository and has to make sure, it works as intended. The maintainer should be added to the README.md of the repository.

If you are currently working on a repository that has no active maintainer, consult the repository's creator.

Manage access

By default, only you can push to your repositories. At least make sure you add ambimax/developers with the Write role to the repository.

If the maintainer for the repository is not you, make sure to also add the maintainer as "Admin".

Setup branch protection

You generally want your main branch protected from direct pushes. Make sure to setup an appropriate branch protection for the repository.

A branch protection can be setup at Settings > Branches

A good starting point is to enable "Require pull request reviews before merging" with "Dismiss stale pull request approvals when new commits are pushed". This sets up the requirement for Pull Requests to have at least one reviewer before they can be merged.

If your repository has a Continuous Integration Pipeline setup (it should), you can also enable the "Require status checks to pass before merging" option. This sets up the requirement for Pull Requests to have a working CI Pipeline at their last commit.