-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Relates to #13 ## Changes - Add common repo setup instructions so that the template repos don't need to duplicate this info
- Loading branch information
Showing
5 changed files
with
63 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
## Ticket | ||
|
||
{LINK TO TICKET} | ||
|
||
## Changes | ||
|
||
> What was added, updated, or removed in this PR. | ||
## Context for reviewers | ||
|
||
> Testing instructions, background context, more in-depth details of the implementation, and anything else you'd like to call out or ask reviewers. Explain how the changes were verified. | ||
## Testing | ||
|
||
> Screenshots, GIF demos, code examples or output to help show the changes working as expected. ProTip: you can drag and drop or paste images into this textbox. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Initial setup steps for new project repos | ||
|
||
Below are common repo setup steps for new projects. These steps are recommendations but not required. | ||
|
||
## General settings | ||
|
||
In the project repo's `Settings > General`: | ||
|
||
- Under "Features": | ||
- Enable/disable features that you want for your project. For example, turn off the Wiki if your project won't be using it. | ||
- Under "Pull Requests": | ||
- Enable only the merge options your project should support. It's common to only support squash merging to keep the commit history clean. | ||
- Check "Always suggest updating pull request branches" to encourage pull requests to be updated when they deviate from `main` | ||
- Check "Automatically delete head branches" to automatically delete branches once they are merged into `main` | ||
|
||
## Branch protections | ||
|
||
[Branch protections](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches) are a great way to enforce code quality and prevent accidental merges. | ||
|
||
 | ||
|
||
Typical branch protections for `main` include: | ||
|
||
- Require a pull request before merging | ||
- Require approvals (Minimum of 1) | ||
- Require status checks to pass before merging | ||
|
||
## Security settings | ||
|
||
In the project repo's `Settings > Code security and analysis`: | ||
|
||
- Enable "Dependabot alerts" | ||
- Enable "Dependabot security updates" | ||
|
||
 |