Skip to content

Configure GitHub¤

The generated templates make some assumptions about how the GitHub repository is configured. Here is a summary of changes you should do to the repository Settings to make sure everything works as expected.

Issues¤

Labels¤

Review the list of labels and add:

  • part:xxx labels that make sense to the project

  • Make sure there is a cmd:skip-release-notes label, and if there isn't, create one with 930F79 as color and the following description:

    It is not necessary to update release notes for this PR

  • All labels used by automation in the project, for example look for labels listed in:

    • .github/keylabeler.yml
    • .github/labeler.yml
    • .github/dependabot.yml
    • .github/workflows/release-notes-check.yml

Discussions¤

This depends on the repo, but in general we want this:

  • Remove the Show and tell and Poll categories

  • Rename the Q&A category to Support and change the emoji to :sos:

This one is important to match the link provided in .github/ISSUE_TEMPLATE/config.yml.

Settings¤

General¤

Default branch¤

  • Rename to v0.x.x (this is required for the common CI to work properly when creating releases)

Features¤

  • Wikis
  • Issues
  • Sponsorships
  • Projects
  • Preserve this repository
  • Discussions

Pull Requests¤

  • Allow merge commits: Default to pull request title and description
  • Allow squash merging
  • Allow rebase merging
  • Always suggest updating pull request branches
  • Allow auto-merge
  • Automatically delete head branches

Archives¤

  • Include Git LFS objects in archives

Pushes¤

  • Limit how many branches and tags can be updated in a single push: 5

Collaborators and teams¤

  • Give the team owning the repository Role: Admin
  • Give everybody team Role: Triage

Rules¤

Rulesets¤

Importing rulesets

Import the following rulesets:

Note

You might need to adapt the status checks in the Protect version branches ruleset depending on your repository configuration.

Code security and analysis¤

  • Enable Dependabot version updates if relevant

Code¤

The basic code configuration should be generate using repo-config.

GitHub Pages¤

No special configuration is needed for GitHub Pages, but you need to initialize the gh-pages branch. You can read how to do this in the Initialize GitHub Pages section.