Share
Sign In
git repo setting
Overall
PR setting
Options | Checked |
Allow merge commits | o |
Allow squash merging | o |
Allow rebase merging | o |
Always suggest updating pull request branches | x |
Allow auto-merge | o |
Automatically delete head branches | o |
Issues template
Configuring issue templates for your repository
You can customize the templates that are available for contributors to use when they open new issues in your repository.
You can create default issue templates and a default configuration file for issue templates for your organization or personal account. For more information, see "Creating a default community health file."
Creating issue templates
1.
On GitHub.com, navigate to the main page of the repository.
2.
Under your repository name, click Settings.
3.
In the "Features" section, under "Issues," click Set up templates.
4.
Use the Add template drop-down menu, and click on the type of template you'd like to create.
5.
To preview or edit the template before committing it to the repository, click Preview and edit.
6.
To edit the template, click , and type in the fields to edit their contents.
7.
To automatically set a default issue title, assign the issue to people with read access to the repository, or apply labels to your issue template, enter these details under "Optional additional information." You can also add these details in the issue template with title, labels, or assignees in a YAML frontmatter format.
8.
When you're finished editing and previewing your template, click Propose changes in the upper right corner of the page.
9.
Enter a commit message describing your changes.
10.
Below the commit message fields, decide whether to commit your template directly to the default branch, or to create a new branch and open a pull request. For more information about pull requests, see "About pull requests."
11.
Click Commit changes. Once these changes are merged into the default branch, the template will be available for contributors to use when they open new issues in the repository.
Creating issue forms
Note: Issue forms are currently in beta for public repositories on GitHub.com only.
With issue forms, you can create issue templates that have customizable web form fields. You can encourage contributors to include specific, structured information by using issue forms in your repository. Issue forms are written in YAML using the GitHub form schema. For more information, see "Syntax for GitHub's form schema." If you're new to YAML and want to learn more, see "Learn YAML in Y minutes."
To use an issue form in your repository, you must create a new file and add it to the .github/ISSUE_TEMPLATE folder in your repository.
Here is an example of an issue form configuration file.
YAML
Here is the rendered version of the issue form.
1.
Choose a repository where you want to create an issue form. You can use an existing repository that you have write access to, or you can create a new repository. For more information about creating a repository, see "Creating a new repository."
2.
In your repository, create a file called .github/ISSUE_TEMPLATE/FORM-NAME.yml, replacing FORM-NAME with the name for your issue form. For more information about creating new files on GitHub, see "Creating new files."
3.
In the body of the new file, type the contents of your issue form. For more information, see "Syntax for issue forms."
4.
Commit your file to the default branch of your repository. For more information, see "Creating new files."
PR template
Merge Options
Managing the automatic deletion of branches
You can have head branches automatically deleted after pull requests are merged in your repository.
In git flow and gitlab flow, if it is a branch that should not be deleted after merging, the branch protection option should prevent deletion.
In git flow and gitlab flow, if it is a branch that should not be deleted after merging, the branch protection option should prevent deletion.
Anyone with admin permissions to a repository can enable or disable the automatic deletion of branches.
1.
On GitHub.com, navigate to the main page of the repository.
2.
Under your repository name, click Settings.
3.
Under "Pull Requests", select or unselect Automatically delete head branches.
Managing auto-merge
Note: The option to enable auto-merge is shown only on pull requests that cannot be merged immediately.
For example, when a branch protection rule enforces "Require pull request reviews before merging" or "Require status checks to pass before merging" and these conditions are not yet met. For more information, see "Managing a branch protection rule."
1.
On GitHub.com, navigate to the main page of the repository.
2.
Under your repository name, click Settings.
3.
Under "Pull Requests", select or deselect Allow auto-merge.
Branch Protection
Overall
PR setting
Options | Checked |
Allow merge commits | o |
Allow squash merging | o |
Allow rebase merging | o |
Always suggest updating pull request branches | x |
Allow auto-merge | o |
Automatically delete head branches | o |
Issues template
Configuring issue templates for your repository
You can customize the templates that are available for contributors to use when they open new issues in your repository.
You can create default issue templates and a default configuration file for issue templates for your organization or personal account. For more information, see "Creating a default community health file."
Creating issue templates
1.
On GitHub.com, navigate to the main page of the repository.
2.
Under your repository name, click Settings.
3.
In the "Features" section, under "Issues," click Set up templates.
4.
Use the Add template drop-down menu, and click on the type of template you'd like to create.
5.
To preview or edit the template before committing it to the repository, click Preview and edit.
6.
To edit the template, click , and type in the fields to edit their contents.
7.
To automatically set a default issue title, assign the issue to people with read access to the repository, or apply labels to your issue template, enter these details under "Optional additional information." You can also add these details in the issue template with title, labels, or assignees in a YAML frontmatter format.
8.
When you're finished editing and previewing your template, click Propose changes in the upper right corner of the page.
9.
Enter a commit message describing your changes.
10.
Below the commit message fields, decide whether to commit your template directly to the default branch, or to create a new branch and open a pull request. For more information about pull requests, see "About pull requests."
11.
Click Commit changes. Once these changes are merged into the default branch, the template will be available for contributors to use when they open new issues in the repository.
Creating issue forms
Note: Issue forms are currently in beta for public repositories on GitHub.com only.
With issue forms, you can create issue templates that have customizable web form fields. You can encourage contributors to include specific, structured information by using issue forms in your repository. Issue forms are written in YAML using the GitHub form schema. For more information, see "Syntax for GitHub's form schema." If you're new to YAML and want to learn more, see "Learn YAML in Y minutes."
To use an issue form in your repository, you must create a new file and add it to the .github/ISSUE_TEMPLATE folder in your repository.
Here is an example of an issue form configuration file.
YAML
Here is the rendered version of the issue form.
1.
Choose a repository where you want to create an issue form. You can use an existing repository that you have write access to, or you can create a new repository. For more information about creating a repository, see "Creating a new repository."
2.
In your repository, create a file called .github/ISSUE_TEMPLATE/FORM-NAME.yml, replacing FORM-NAME with the name for your issue form. For more information about creating new files on GitHub, see "Creating new files."
3.
In the body of the new file, type the contents of your issue form. For more information, see "Syntax for issue forms."
4.
Commit your file to the default branch of your repository. For more information, see "Creating new files."
PR template
Merge Options
Managing the automatic deletion of branches
You can have head branches automatically deleted after pull requests are merged in your repository.
In git flow and gitlab flow, if it is a branch that should not be deleted after merging, the branch protection option should prevent deletion.
In git flow and gitlab flow, if it is a branch that should not be deleted after merging, the branch protection option should prevent deletion.
Anyone with admin permissions to a repository can enable or disable the automatic deletion of branches.
1.
On GitHub.com, navigate to the main page of the repository.
2.
Under your repository name, click Settings.
3.
Under "Pull Requests", select or unselect Automatically delete head branches.
Managing auto-merge
Note: The option to enable auto-merge is shown only on pull requests that cannot be merged immediately.
For example, when a branch protection rule enforces "Require pull request reviews before merging" or "Require status checks to pass before merging" and these conditions are not yet met. For more information, see "Managing a branch protection rule."
1.
On GitHub.com, navigate to the main page of the repository.
2.
Under your repository name, click Settings.
3.
Under "Pull Requests", select or deselect Allow auto-merge.
Branch Protection
Overall
PR setting
Options | Checked |
Allow merge commits | o |
Allow squash merging | o |
Allow rebase merging | o |
Always suggest updating pull request branches | x |
Allow auto-merge | o |
Automatically delete head branches | o |
Issues template
Configuring issue templates for your repository
You can customize the templates that are available for contributors to use when they open new issues in your repository.
You can create default issue templates and a default configuration file for issue templates for your organization or personal account. For more information, see "Creating a default community health file."
Creating issue templates
1.
On GitHub.com, navigate to the main page of the repository.
2.
Under your repository name, click Settings.
3.
In the "Features" section, under "Issues," click Set up templates.
4.
Use the Add template drop-down menu, and click on the type of template you'd like to create.
5.
To preview or edit the template before committing it to the repository, click Preview and edit.
6.
To edit the template, click , and type in the fields to edit their contents.
7.
To automatically set a default issue title, assign the issue to people with read access to the repository, or apply labels to your issue template, enter these details under "Optional additional information." You can also add these details in the issue template with title, labels, or assignees in a YAML frontmatter format.
8.
When you're finished editing and previewing your template, click Propose changes in the upper right corner of the page.
9.
Enter a commit message describing your changes.
10.
Below the commit message fields, decide whether to commit your template directly to the default branch, or to create a new branch and open a pull request. For more information about pull requests, see "About pull requests."
11.
Click Commit changes. Once these changes are merged into the default branch, the template will be available for contributors to use when they open new issues in the repository.
Creating issue forms
Note: Issue forms are currently in beta for public repositories on GitHub.com only.
With issue forms, you can create issue templates that have customizable web form fields. You can encourage contributors to include specific, structured information by using issue forms in your repository. Issue forms are written in YAML using the GitHub form schema. For more information, see "Syntax for GitHub's form schema." If you're new to YAML and want to learn more, see "Learn YAML in Y minutes."
To use an issue form in your repository, you must create a new file and add it to the .github/ISSUE_TEMPLATE folder in your repository.
Here is an example of an issue form configuration file.
YAML
Here is the rendered version of the issue form.
1.
Choose a repository where you want to create an issue form. You can use an existing repository that you have write access to, or you can create a new repository. For more information about creating a repository, see "Creating a new repository."
2.
In your repository, create a file called .github/ISSUE_TEMPLATE/FORM-NAME.yml, replacing FORM-NAME with the name for your issue form. For more information about creating new files on GitHub, see "Creating new files."
3.
In the body of the new file, type the contents of your issue form. For more information, see "Syntax for issue forms."
4.
Commit your file to the default branch of your repository. For more information, see "Creating new files."
PR template
Merge Options
Managing the automatic deletion of branches
You can have head branches automatically deleted after pull requests are merged in your repository.
In git flow and gitlab flow, if it is a branch that should not be deleted after merging, the branch protection option should prevent deletion.
In git flow and gitlab flow, if it is a branch that should not be deleted after merging, the branch protection option should prevent deletion.
Anyone with admin permissions to a repository can enable or disable the automatic deletion of branches.
1.
On GitHub.com, navigate to the main page of the repository.
2.
Under your repository name, click Settings.
3.
Under "Pull Requests", select or unselect Automatically delete head branches.
Managing auto-merge
Note: The option to enable auto-merge is shown only on pull requests that cannot be merged immediately.
For example, when a branch protection rule enforces "Require pull request reviews before merging" or "Require status checks to pass before merging" and these conditions are not yet met. For more information, see "Managing a branch protection rule."
1.
On GitHub.com, navigate to the main page of the repository.
2.
Under your repository name, click Settings.
3.
Under "Pull Requests", select or deselect Allow auto-merge.
Branch Protection
Overall
PR setting
Options | |