Onboardings and Setup Guides

Github

About repositories

A repository is usually used to organize a single project. Repositories can contain folders and files, images, videos, spreadsheets, and data sets — anything your project needs.

About projects

A project is an adaptable spreadsheet that integrates with your issues and pull requests on GitHub to help you plan and track your work effectively. Your projects are built from the issues and pull requests you add, creating direct references between your project and your work. Information is synced automatically to your project as you make changes, updating your views and charts. This integration works both ways, so that when you change information about a pull request or issue in your project, the pull request or issue reflects that information. For example, change an assignee in your project and that change is shown in your issue.

See https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects

Branching Strategy

  1. The main branch contains the latest feature set and is ready to be released.

  2. Features are developed in branches (naming convention = feat/<the-name>).

  3. Releases are prepared and tested in branches (naming convention = release/vX.X.X → e.g. release/v0.1.0).

  4. Tags are created based on release branches (naming convention = vX.X.X → e.g. v0.1.0). After tagging the release branch is deleted.

branching strategy.drawio

Setup new Repository

  1. Create a new repository on Github

  2. Apply Github Configuration

  3. Setup Dependabot (Github UI: Settings → Code security and analysis → Dependabot security updates)

    1. Adjust dependabot.yml to your needs.

Add collaborators to projects and repos

When you are working on a project with more people than just yourself, all collaborators need permissions to update the source code repositories and work with issues and projects.

  1. Projects

    1. Go to respective project

    2. Open Settings (…​ (ths symbol in the top-right corner) > Settings)

    3. Go to Manage Access and Invite collaborators

  2. Repositories

    1. Go to the respective repository

    2. Go to Settings > Collaborators and add Users in the Manage access section