Skip to content

Latest commit

 

History

History
70 lines (49 loc) · 2.29 KB

README.md

File metadata and controls

70 lines (49 loc) · 2.29 KB

Template for EGI repositories

This repository is to be used as a repository template for creating a new EGI repository, and is aiming at being a clean basis promoting currently accepted good practices.

It includes:

  • License information
  • Copyright and author information
  • Code of conduct and contribution guidelines
  • Templates for PR and issues
  • Code owners file for automatic assignment of PR reviewers
  • GitHub actions workflows for linting and checking links

Content is based on:

Asking for creation of a repository

It can be done by contacting the administrators.

The following information should be provided:

  • repository name (lower case, usually not required to mention EGI in the name)
  • repository description (oneliner is enough)
  • optionally additional users that should be able to manage PR and issues
  • optional additional requirements (like disabling Pull Requests for the initial repository population)

If required a private repository can be created but public ones are the default, but feel free to ask.

Once all info will have been agreed the repository will be created.

GitHub repository management rules

All changes should go through Pull Requests.

Merge management

  • Only squash should be enforced in the repository settings.
  • Update commit message for the squashed commits as needed.

Protection on main branch

To be configured on the repository settings.

  • Require pull request reviews before merging
    • Dismiss stale pull request approvals when new commits are pushed
    • Require review from Code Owners
  • Require status checks to pass before merging
    • GitHub actions if available
    • Other checks as available and relevant
    • Require branches to be up to date before merging
  • Include administrators

Access

All access should be managed via GitHub teams.

  • EGI-Federation/admins: administration right
  • Others participants depending on the requirement: maintain, triage or write or rights