Configuring a new project
So you’ve created a new python project from the template! Great!
Now let’s get other services linked up to your new project to make the most of what the template and open source CI has to offer!
Configure your GitHub repository for safety and security
Consider setting up branch protection rules.
This will help ensure your code is always ready to deploy by running all tests pass to merging into the
mainbranch.
Enable
dependabotfor your new repositoryThere are several different features that
dependabotoffers to keep your dependencies up to date and your code secure. It’s as easy as clicking a checkbox to get started.
Add another GitHub user as an administrator on your repository
It’s just a good idea - like having a spare set of keys for your Lamborghini.
Configure your GitHub repository for convenience
There are several convenient options in GitHub that are not enabled by default. We find ourselves setting these options on all our development repositories, and list them here for reference.
In your repo, “Settings” tab, “General” page, scroll down to the “Pull Requests” section:
Check “Allow squash merging”. This lets you combine several intermediate commits on a development branch into a single merge into main. The merge history will stay cleaner.
Check “Allow auto-merge”. This lets you set a pull request to automatically merge when all required reviews and status criteria is met. This can be great when working with folks in other time zones - you don’t need to be around to merge your change once it’s ready.
Check “Automatically delete head branches”. If you’re working in development branches and only merging in to main with pull requests (which you should do!), your repo may quickly fill up with stale development branches. With this feature enabled, your development branches will be automatically deleted once the pull requests are merged into main.