RustTemplate

Extras

Signing commits

You have to setup commit signing if you want to use my Workflow and in general you should set this up as it proves your work is actually yours. To actually do this you can follow the whole Verify commit signatures section on this GitHub article

Repository Settings

All of the following assume you are in the Settings page of your repository. Just click settings on the toolbar up top on your repository page.

General Section

Social Preview

After I‘ve got a repository about description, I like to generate a social preview with this tool, edit it to remove how many stars the repository has, so I don’t have to update it, and then add it on GitHub.

Enable Wikis

Enable Wikis and any extra documentation you may have written in the docs/ folder publish it here too.

Sponsorships

If you haven’t added a way to get donations when setting up the template this might be a good time to do so.

Discussion

This is a great way to stay connected with your community. Enable this and just start by opening a discussion on the general topic beginning with a message like this:

Welcome to the General Discussions page! Please don't forget to read our CODE_OF_CONDUCT.md

Branches section

Branch protection rules

In order to properly follow my workflow you will have to create a new rule with the following settings:

Rules

Rulesets

This is going put some restrictions on the branches you work on to then merge to master, like requiring a linear history and signed commits. So create a new rule with following options:

Pages

The following are settings for the site hosted with the content from the docs/ folder

Code security and analysis