Skip to content

Requirements and Good Practices

Mandatory Information

  • All Repositories and Teams must fill out the descriptionfield in the about-section. This description is visible when listing repositories/teams and makes it easier for other people to understand what your projects are all about.
  • All Repositories must include a README or README.md file with more detailed information about the content. Please note the convention of using all uppercase in the file name
  • Repositories should include a CODEOWNERS file located in the .github directory

Naming Conventions

  • We use kebab-case ("hyphenated words") for Repositories and Teams. i.e use my-awesome-repo and not MyAwesomeRepo
  • Use descriptive names to make it easier for other people to navigate

Good Practices

  • Use branch protection rules to require pull requests for pushing to the main branch
  • Prefer GitHub Teams to manage admin permissions if you maintain more than one repository over assigning permissions directly to repositories. (Note that external collaborators must be added to repositories and cannot be members of github teams)
  • Enable Dependabot to give you automatic security alerts, security updates and version updates. Dependabot is free to use, scan your dependencies and create pull requests to make keeping current easier