text stringlengths 12 91.7k | metadata dict |
|---|---|
Dismissing a review changes the status of the review to a review comment. When you dismiss a review, you must add a comment explaining why you dismissed it. Your comment will be added to the pull request conversation.
1. On the "Conversation" tab, next to the summary of reviews, click .
!Screenshot of the merge box ... | {
"source": "github-docs/pull-requests/how-tos/review-pull-requests/dismissing-a-pull-request-review.md",
"title": "Dismissing a pull request review"
} |
Applying suggested changes
Other people can suggest specific changes to your pull request. You can apply these suggested changes directly in a pull request if you have write access to the repository.
If the pull request was created from a fork and the author allowed edits from maintainers, you can also apply suggested ... | {
"source": "github-docs/pull-requests/how-tos/review-pull-requests/incorporating-feedback-in-your-pull-request.md",
"title": "Incorporating feedback in your pull request"
} |
<!--Marketing-LINK: From /features/security/software-supply-chain page "Sign up for the dependency review " and "Reviewing dependency changes in a pull request".--
About dependency review
Before you can use dependency review, you must enable the dependency graph. See AUTOTITLE.
Before you can use dependency review, yo... | {
"source": "github-docs/pull-requests/how-tos/review-pull-requests/reviewing-dependency-changes-in-a-pull-request.md",
"title": "Reviewing dependency changes in a pull request"
} |
About reviewing pull requests
It's best to review changes in a pull request one file at a time:
Examine each individual file changed in the pull request.
Leave comments on specific changes.
After reviewing a file, mark it as Viewed to collapse it and track your progress.
The progress bar in the pull request header ... | {
"source": "github-docs/pull-requests/how-tos/review-pull-requests/reviewing-proposed-changes-in-a-pull-request.md",
"title": "Reviewing proposed changes in a pull request"
} |
Each pull request in a stack shows only the diff for its layer. This means reviewers can request changes on any pull request independently. When a reviewer requests changes on a pull request mid-stack, you should make the fix on the branch that owns the change and rebase so the branches above it pick up your update.
A... | {
"source": "github-docs/pull-requests/how-tos/review-pull-requests/reviewing-stacked-pull-requests.md",
"title": "Reviewing stacked pull requests"
} |
When you view a full review, you see the same version of the pull request as the reviewer did at the time of the review.
1. On the "Conversation" tab, scroll to the review you want to see, then click View changes.
!Screenshot of a review. The "View changes" link is outlined in dark orange.
Further reading
AUTOTITL... | {
"source": "github-docs/pull-requests/how-tos/review-pull-requests/viewing-a-pull-request-review.md",
"title": "Viewing a pull request review"
} |
When someone creates a pull request from their fork, they usually decide whether other people can commit to the pull request's compare branch. For greater collaboration, the author can give maintainers of the upstream repository—that is, anyone with push access to the upstream repository—permission to commit to the com... | {
"source": "github-docs/pull-requests/how-tos/work-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md",
"title": "Allowing changes to a pull request branch created from a fork"
} |
1. Open your terminal or Git Bash.
1. List the remotes currently configured for your fork.
shell
$ git remote -v
origin https:///YOUR-USERNAME/YOUR-FORK.git (fetch)
origin https:///YOUR-USERNAME/YOUR-FORK.git (push)
1. Add a new remote named upstream that points to the original repository.
shell
g... | {
"source": "github-docs/pull-requests/how-tos/work-with-forks/configuring-a-remote-repository-for-a-fork.md",
"title": "Configuring a remote repository for a fork"
} |
Converting a fork into a standalone repository
To turn your fork into a standalone repository, you can leave the fork network. The new repository will no longer automatically sync with changes from the original repository. This is useful when you want to take your work in a different direction or maintain distinct vers... | {
"source": "github-docs/pull-requests/how-tos/work-with-forks/detaching-a-fork.md",
"title": "Detaching a fork"
} |
About forks
Forking a repository lets you propose changes to a project without affecting the upstream repository. See AUTOTITLE.
Prerequisites
If you haven't already, set up Git and authentication with from Git. See AUTOTITLE.
Forking a repository
You might fork a project to propose changes to the upstream repositor... | {
"source": "github-docs/pull-requests/how-tos/work-with-forks/fork-a-repo.md",
"title": "Fork a repository"
} |
Syncing a fork branch from the web UI
1. On , navigate to the main page of the forked repository that you want to sync with the upstream repository.
1. Above the list of files, select the Sync fork dropdown menu.
!Screenshot of the main page of a fork. A dropdown menu, labeled with a sync icon and "Sync fork," is o... | {
"source": "github-docs/pull-requests/how-tos/work-with-forks/syncing-a-fork.md",
"title": "Syncing a fork"
} |
About branches
Branches let you develop features, fix bugs, or safely experiment with new ideas in a contained area of your repository.
You always create a branch from an existing branch. Typically, you might create a new branch from the default branch of your repository. You can then work on this new branch in isolati... | {
"source": "github-docs/pull-requests/reference/branches.md",
"title": "Branches"
} |
About commits
If the repository you are committing to requires commit signoffs, and you are committing in the web interface, you will automatically sign off on the commit. See AUTOTITLE.
You can add a co-author on any commits you collaborate on. See AUTOTITLE.
You can also create a commit on behalf of an organization. ... | {
"source": "github-docs/pull-requests/reference/commits.md",
"title": "Commits"
} |
Forks are repositories that start as copies of another repository, called the upstream repository. A fork has its own settings and permissions but stays connected to the upstream repository.
When you view a forked repository on , the upstream repository is indicated below the name of the fork.
What makes forks distinc... | {
"source": "github-docs/pull-requests/reference/forks.md",
"title": "Forks"
} |
If you maintain a repository, you can use features to make pull requests more consistent and easier to review. Standardization helps contributors know what information to provide, helps reviewers focus on the right changes, and helps protect important branches from accidental or risky merges.
Using pull request templ... | {
"source": "github-docs/pull-requests/reference/managing-and-standardizing-pull-requests.md",
"title": "Managing and standardizing pull requests"
} |
Git can often resolve differences between branches and merge them automatically. Usually, changes are on different lines or in different files, so Git can merge them without help. Sometimes, competing changes need your help. Merge conflicts often happen when people make different changes to the same line of the same fi... | {
"source": "github-docs/pull-requests/reference/merge-conflicts.md",
"title": "Merge conflicts"
} |
Pull requests can be merged in different ways. The best strategy depends on how your team wants the repository history to look and how much detail you want to preserve from the pull request branch.
Strategy Result Choose when
--- --- ---
Merge commit Preserves every commit from the pull request branch and add... | {
"source": "github-docs/pull-requests/reference/pull-request-merges.md",
"title": "Pull request merges"
} |
Pull request reviews let people comment on changes, suggest improvements, and approve or request changes before code is merged. Anyone with read access can review and comment on proposed changes, helping teams maintain code quality and share knowledge.
<a href="https://github.com/pulls/review-requested?refproduct=githu... | {
"source": "github-docs/pull-requests/reference/pull-request-reviews.md",
"title": "Pull request reviews"
} |
Pull requests are proposals to merge code changes into a project. A pull request is 's key collaboration feature, letting you discuss and review changes before merging them. This helps teams work together, catch issues early, and maintain code quality.
<a href="https://github.com/pulls?refproduct=github&reftype=engagem... | {
"source": "github-docs/pull-requests/reference/pull-requests.md",
"title": "Pull requests"
} |
The gh stack extension for creates and manages stacks of pull requests from your local repository. For an introduction to stacks, see AUTOTITLE.
Installation
gh extension install github/gh-stack
The extension requires (gh) version 2.0 or later.
[!NOTE]
The gh stack extension uses your authentication. If you have ... | {
"source": "github-docs/pull-requests/reference/stacked-prs-cli-commands.md",
"title": "Stacked pull requests CLI commands"
} |
Preconditions
The command checks these conditions before opening the interface:
1. You must have an active stack checked out locally.
1. Your working tree must be clean, with no uncommitted changes.
1. No rebase is in progress.
1. No pull request in the stack is queued for merge.
1. Commit history must be linear, with ... | {
"source": "github-docs/pull-requests/reference/stacked-prs-cli-commands.md",
"title": "Stacked pull requests CLI commands"
} |
After modifying
If you have already created a stack of pull requests on , run gh stack submit to push the updated branches and recreate the stack. The old stack is replaced automatically.
Examples:
# Open the interactive modify interface
gh stack modify
# Continue after resolving a conflict
gh stack modify --continue
#... | {
"source": "github-docs/pull-requests/reference/stacked-prs-cli-commands.md",
"title": "Stacked pull requests CLI commands"
} |
The REST and GraphQL APIs both expose stacked pull requests. The REST API supports reading and managing stacks, while the GraphQL API supports read-only queries.
Use the API to read a pull request's stack membership or to build your own automation and integrations for stacked pull requests.
REST API
The REST API expo... | {
"source": "github-docs/pull-requests/reference/stacked-pull-requests-rest-and-graphql-apis.md",
"title": "Stacked pull requests in the REST and GraphQL APIs"
} |
Every pull request in a stack is evaluated against rules for the base of the stack — typically main — regardless of which branch it directly targets. This means mid-stack pull requests are held to the same standard as the bottom pull request.
[!NOTE]
Stacked pull requests availability
The gh stack extension handles ... | {
"source": "github-docs/pull-requests/reference/stacked-pull-requests.md",
"title": "Stacked pull requests"
} |
Status checks show whether commits meet the conditions set for a repository. They are usually created by external systems, such as continuous integration builds, tests, code scanning, or deployment checks.
Status checks help reviewers and maintainers understand whether a pull request is ready to merge. A check can show... | {
"source": "github-docs/pull-requests/reference/status-checks.md",
"title": "Status checks"
} |
Stacked pull requests are built on standard Git branches and regular pull requests, so you can choose to use tools other than the gh stack CLI for your local workflow. If you manage branch chains with another tool, such as Jujutsu (jj), Sapling, or git-town, you can use the gh stack link command to open those branches ... | {
"source": "github-docs/pull-requests/reference/use-other-tools-with-stacked-pull-requests.md",
"title": "Use other tools with stacked pull requests"
} |
You can add query parameters to a compare URL to open a pull request with pre-populated fields. For pull request templates, see AUTOTITLE.
Parameter Purpose Example
--- --- ---
quickpull Opens the "Open a pull request" page for the compared branches. https://github.com/octo-org/octo-repo/compare/main...my-br... | {
"source": "github-docs/pull-requests/reference/using-query-parameters-to-create-a-pull-request.md",
"title": "Using query parameters to create a pull request"
} |
Pre-receive hooks are scripts that run on before Git accepts pushed commits. They enforce repository, organization, or enterprise policy at the point where code enters a repository.
A pre-receive hook can check whether a push follows required rules. For example, a hook might block pushes that include secrets, use nons... | {
"source": "github-docs/pull-requests/reference/working-with-pre-receive-hooks.md",
"title": "Working with pre-receive hooks"
} |
[!NOTE]
Stacked pull requests are in and subject to change.
Stacked pull requests let developers break large changes into a chain of small, focused pull requests that build on each other, making each layer easier to review, merge, and ship. Stacked pull requests give developers the flexibility to finish one piece of ... | {
"source": "github-docs/pull-requests/tutorials/roll-out-stacked-prs.md",
"title": "Roll out stacked pull requests to your organization"
} |
Large pull requests are difficult to review and create bottlenecks, especially when you generate a high volume of code in a short time. Review quality also degrades as pull request size increases. Reviewers may skim the result, miss issues, or procrastinate and leave the pull request until it grows stale and develops m... | {
"source": "github-docs/pull-requests/tutorials/stack-code-changes-in-pull-requests.md",
"title": "Stack code changes in pull requests"
} |
Persistence of public repositories
intends to keep your public repositories available unless you remove them. In some cases, we may make public content unavailable, for example if:
We receive a DMCA Takedown Notice for content in a repository.
We determine that a repository's content violates our Community Guideline... | {
"source": "github-docs/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md",
"title": "About archiving content and data on GitHub"
} |
About repository archival
[!NOTE]
If you have a legacy per-repository billing plan, you will still be charged for your archived repository. If you don't want to be charged for an archived repository, you must upgrade to a new product. For more information, see AUTOTITLE.
[!NOTE]
Customers who use can enable on ar... | {
"source": "github-docs/repositories/archiving-a-github-repository/archiving-repositories.md",
"title": "Archiving repositories"
} |
You may want to take backups of repositories for archiving or disaster recovery purposes.
Depending on the features you use and your requirements (for example whether you need to be able to restore the backup), there are different backup options which include different data.
You may want to store your backups on an ex... | {
"source": "github-docs/repositories/archiving-a-github-repository/backing-up-a-repository.md",
"title": "Backing up a repository"
} |
Issuing a persistent identifier for your repository with Zenodo
To make your repositories easier to reference in academic literature, you can create persistent identifiers, also known as Digital Object Identifiers (DOIs). You can use the data archiving tool Zenodo to archive a repository on and issue a DOI for the arc... | {
"source": "github-docs/repositories/archiving-a-github-repository/referencing-and-citing-content.md",
"title": "Referencing and citing content"
} |
You can enforce one type of merge method, such as commit squashing or rebasing, by only enabling the desired method for your repository.
[!NOTE]
When using the merge queue, you no longer get to choose the merge method, as this is controlled by the queue.
Merge methods set on the repository that conflict with the me... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md",
"title": "About merge methods on GitHub"
} |
1. Under "Pull Requests", select Allow merge commits. This allows contributors to merge a pull request with a full history of commits.
1. Optionally, under Allow merge commits, select the dropdown menu, then click the format of the commit message presented to contributors when merging.
The default message includes t... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md",
"title": "Configuring commit merging for pull requests"
} |
1. Under "Pull Requests", select Allow rebase merging. This allows contributors to merge a pull request by rebasing their individual commits onto the base branch.
If you also select another merge method, collaborators will be able to choose the type of merge commit when merging a pull request. | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md",
"title": "Configuring commit rebasing for pull requests"
} |
1. On the "General" settings page (which is selected by default), scroll down to the section marked "Pull Requests".
1. Under "Pull Requests", select Allow squash merging. This allows contributors to merge a pull request by squashing all commits into a single commit. The default commit message presented to contributors... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md",
"title": "Configuring commit squashing for pull requests"
} |
About merge queues
For more information on merging a pull request using a merge queue, see AUTOTITLE.
Configuring continuous integration (CI) workflows for merge queues
[!NOTE]
A merge queue cannot be enabled with branch protection rules that use wildcard characters () in the branch name pattern.
A merge queue wi... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md",
"title": "Managing a merge queue"
} |
About auto-merge
If you allow auto-merge for pull requests in your repository, people with write permissions can configure individual pull requests in the repository to merge automatically when all merge requirements are met. If someone who does not have write permissions pushes changes to a pull request that has auto-... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md",
"title": "Managing auto-merge for pull requests in your repository"
} |
About suggestions to update a pull request branch
If you enable the setting to always suggest updating pull request branches in your repository, people with write permissions will always have the ability, on the pull request page, to update a pull request's head branch when it's not up to date with the base branch. Whe... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches.md",
"title": "Managing suggestions to update pull request branches"
} |
Anyone with admin permissions to a repository can enable or disable the automatic deletion of branches. Branch protection rules and repository rules can also prevent branches being automatically deleted. For more information, see AUTOTITLE and AUTOTITLE.
1. On the "General" settings page, you can find a section called ... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md",
"title": "Managing the automatic deletion of branches"
} |
About changing the default branch
You can choose the default branch for a repository. The default branch is the base branch for pull requests and code commits. For more information about the default branch, see AUTOTITLE.
You can also rename the default branch. For more information, see AUTOTITLE.
Prerequisites
To cha... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch.md",
"title": "Changing the default branch"
} |
Deleting a branch used for a pull request
You can delete a branch that is associated with a pull request if the pull request has been merged or closed and there are no other open pull requests referencing the branch. For information on closing branches that are not associated with pull requests, see AUTOTITLE.
1. In th... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md",
"title": "Deleting and restoring branches in a pull request"
} |
About renaming branches
You can rename a branch in a repository on . For more information about branches, see AUTOTITLE.
When you rename a branch, any URLs that contain the old branch name are automatically redirected to the equivalent URL for the renamed branch. Branch protection policies are also updated, as well as ... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md",
"title": "Renaming a branch"
} |
1. Use the navigation at the top of the page to view specific lists of branches:
Your branches: In repositories that you have push access to, the Yours view shows all branches that you’ve pushed to, excluding the default branch, with the most recent branches first.
Active branches: The Active view shows all b... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md",
"title": "Viewing branches in your repository"
} |
About branch protection rules
[!TIP] If you use branch protection rules that require specific status checks, make sure that job names are unique across all workflows. Using the same job name in multiple workflows can cause ambiguous status check results and block pull requests from being merged. See AUTOTITLE.
You can... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md",
"title": "About protected branches"
} |
About branch protection rules
You can create a rule for all current and future branches in your repository with the wildcard syntax .
If a repository has multiple protected branch rules that affect the same branches, the rules that include a specific branch name have the highest priority. If there is more than one pro... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule.md",
"title": "Managing a branch protection rule"
} |
About rulesets
A ruleset is a named list of rules that applies to a repository or to multiple repositories in an organization for customers on and plans. You can have up to 75 rulesets per repository, and 75 organization-wide rulesets.
When you create a ruleset, you can allow certain users to bypass the rules in the ... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets.md",
"title": "About rulesets"
} |
You can create branch or tag rulesets to control how users can interact with selected branches and tags in a repository. You can also create push rulesets to block pushes to a private or internal repository and that repository's entire fork network.
When you create a ruleset, you can allow certain users to bypass the r... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md",
"title": "Available rules for rulesets"
} |
Introduction
You can create rulesets to control how users can interact with selected branches and tags in a repository. You can control things like who can push commits to a certain branch and how the commits must be formatted, or who can delete or rename a tag. You can also prevent people from renaming repositories.
W... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository.md",
"title": "Creating rulesets for a repository"
} |
After creating a ruleset, you can still make changes to it. For example, you can add rules to better protect your branches or tags, or you can switch your ruleset from "Evaluate" mode to "Active" after testing its effects on the contributor experience for your repositorytemporarily disable a ruleset to troubleshoot any... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md",
"title": "Managing rulesets for a repository"
} |
Troubleshooting rulesets
If you cannot perform an action in a repository and want to know why, you can view the active rulesets targeting the branch or tag you're working with. For more information, see AUTOTITLE.
Depending on which rules are active, you may need to edit your commit history locally before you can push ... | {
"source": "github-docs/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/troubleshooting-rules.md",
"title": "Troubleshooting rules"
} |
About repositories
A repository is the most basic element of . It's a place where you can store your code, your files, and each file's revision history. Repositories can have multiple collaborators and can be either public, internal, or private.
To create a new repository, go to https://github.com/new. For instructions... | {
"source": "github-docs/repositories/creating-and-managing-repositories/about-repositories.md",
"title": "About repositories"
} |
Term Definition
---- ----------
Branch A parallel version of your code that is contained within the repository, but does not affect the primary or main branch.
Clone To download a full copy of a repository's data from , including all versions of every file and folder.
Fork A new repository that shares code and v... | {
"source": "github-docs/repositories/creating-and-managing-repositories/about-repositories.md",
"title": "About repositories"
} |
About collaboration in a personal repository
You can collaborate with others on repositories you own by inviting them as collaborators. Collaborators have access to contribute to your code and manage issues and pull requests.
If you're a member of an , you can only invite other members of your enterprise to collaborate... | {
"source": "github-docs/repositories/creating-and-managing-repositories/access-to-repositories.md",
"title": "Personal repository access and collaboration"
} |
Create a README file
To make it easier for people to understand and navigate your work, we recommend that you create a README file for every repository.
For more information, see AUTOTITLE.
Secure your repository
You should secure your repository using 's available security features to protect your code from vulnerab... | {
"source": "github-docs/repositories/creating-and-managing-repositories/best-practices-for-repositories.md",
"title": "Best practices for repositories"
} |
About cloning a repository
You can clone a repository from to your local computer, or to a codespace, to make it easier to fix merge conflicts, add or remove files, and push larger commits. When you clone a repository, you copy the repository from to your local machine, or to a remote virtual machine when you create ... | {
"source": "github-docs/repositories/creating-and-managing-repositories/cloning-a-repository.md",
"title": "Cloning a repository"
} |
[!TIP]
Owners can restrict repository creation permissions in an organization. For more information, see AUTOTITLE.
[!TIP]
You can also create a repository using the . For more information, see gh repo create in the documentation.
Creating a new repository from the web UI
1. Optionally, to create a repository with... | {
"source": "github-docs/repositories/creating-and-managing-repositories/creating-a-new-repository.md",
"title": "Creating a new repository"
} |
About repository templates
For more information about creation of a repository template, see AUTOTITLE.
[!TIP]
You can also create a repository from a template using the . For more information, see gh repo create in the documentation.
You can choose to include the directory structure and files from only the default... | {
"source": "github-docs/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md",
"title": "Creating a repository from a template"
} |
About template repositories
Creating a template repository
To create a template repository, you must create a repository, then make the repository a template. For more information about creating a repository, see AUTOTITLE.
After you make your repository a template, anyone with access to the repository can generate a ... | {
"source": "github-docs/repositories/creating-and-managing-repositories/creating-a-template-repository.md",
"title": "Creating a template repository"
} |
1. Create a private repository to host the source code from your project.
1. Create a second repository with the permissions you desire to host the issue tracker.
1. Add a README file to the issues repository explaining the purpose of this repository and linking to the issues section.
1. Set your collaborators or teams... | {
"source": "github-docs/repositories/creating-and-managing-repositories/creating-an-issues-only-repository.md",
"title": "Creating an issues-only repository"
} |
delete an organization repository, and these users may be prevented from deleting a repository by an organization or enterprise policy.
Deleting a public repository will not delete any forks of the repository.
[!WARNING]
Deleting a repository will permanently delete team permissions. This action cannot be undone.
... | {
"source": "github-docs/repositories/creating-and-managing-repositories/deleting-a-repository.md",
"title": "Deleting a repository"
} |
[!NOTE]
If you have a project hosted on another Git-based hosting service, you can automatically import your project to using the tool. For more information, see AUTOTITLE.
Before you can push the original repository to your new copy, or mirror, of the repository, you must create the new repository on . In these exa... | {
"source": "github-docs/repositories/creating-and-managing-repositories/duplicating-a-repository.md",
"title": "Duplicating a repository"
} |
Create a repository
repositories store a variety of projects. In this guide, you'll create a repository and commit your first change.
1. Type a short, memorable name for your repository. For example, "hello-world".
!Screenshot of the first step in creating a repository. The "Repository name" field contains the text... | {
"source": "github-docs/repositories/creating-and-managing-repositories/quickstart-for-repositories.md",
"title": "Quickstart for repositories"
} |
When you rename a repository, all existing information, with the exception of project site URLs, is automatically redirected to the new name, including:
Issues
Wikis
Stars
Followers
For more information on project sites, see AUTOTITLE.
In addition to redirecting web traffic, all git clone, git fetch, or git push op... | {
"source": "github-docs/repositories/creating-and-managing-repositories/renaming-a-repository.md",
"title": "Renaming a repository"
} |
Certain types of repository resources can be quite large, requiring excessive processing on . Because of this, limits are set to ensure requests complete in a reasonable amount of time. Exceeding the recommended maximum limit increases the risk of degraded repository health, which includes, but is not limited to, slow ... | {
"source": "github-docs/repositories/creating-and-managing-repositories/repository-limits.md",
"title": "Repository limits"
} |
Usually, deleted repositories can be restored within 90 days by an enterprise owner on . For more information, see AUTOTITLE.
About repository restoration
A deleted repository can be restored within 90 days, unless the repository was part of a fork network that is not currently empty. A fork network consists of a pare... | {
"source": "github-docs/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md",
"title": "Restoring a deleted repository"
} |
About repository transfers
When you transfer a repository to a new owner, they can immediately administer the repository's contents, issues, pull requests, releases, , and settings. You can also change the repository name while transferring a repository. See AUTOTITLE.
Prerequisites for repository transfers:
When you ... | {
"source": "github-docs/repositories/creating-and-managing-repositories/transferring-a-repository.md",
"title": "Transferring a repository"
} |
HTTPS cloning errors
There are a few common errors when using HTTPS with Git. These errors usually indicate you have an old version of Git, or you don't have access to the repository.
Here's an example of an HTTPS error you might receive:
> error: The requested URL returned error: 401 while accessing
> https://{% data ... | {
"source": "github-docs/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md",
"title": "Troubleshooting cloning errors"
} |
Viewing repositories
Your repository dashboard is available at the top of any page. On the dashboard, you can see repositories by My contributions, My repositories, My forks, and Admin access.
1. At the top of any page, click to see your repositories.
1. Optionally, choose a filter or use the search bar to filter for ... | {
"source": "github-docs/repositories/creating-and-managing-repositories/viewing-all-your-repositories.md",
"title": "Viewing all repositories"
} |
Next steps
To configure workflow execution protections for your repository, including setting up event and actor rules, see AUTOTITLE. | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/actions-policies/about-actions-policies.md",
"title": "About Actions policies"
} |
Configuring workflow execution protections
You configure workflow execution protections in the new Policies section of your settings. This Policies section is separate from your existing General settings.
1. In the left sidebar, under Actions, click Policies.
1. Create a ruleset, then add your event and actor rules.
1... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/actions-policies/workflow-execution-protections.md",
"title": "Workflow execution protections"
} |
About CITATION files
You can add a CITATION.cff file to the root of a repository to let others know how you would like them to cite your work. The citation file format is plain text with human- and machine-readable citation information.
Example CITATION.cff file:
cff-version: 1.2.0
message: "If you use this software, p... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md",
"title": "About CITATION files"
} |
BibTeX
@software{Lisa_My_Research_Software_2017,
author = {Lisa, Mona and Bot, Hew},
doi = {10.5281/zenodo.1234},
month = {12},
title = {{My Research Software}},
url = {https://github.com/github-linguist/linguist},
version = {2.0.4},
year = {2017}
}
Note the example above produces a software citation (tha... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md",
"title": "About CITATION files"
} |
BibTeX
@article{Lisa_My_awesome_research_2021,
author = {Lisa, Mona and Bot, Hew},
doi = {10.0000/00000},
journal = {Journal Title},
month = {9},
number = {1},
pages = {1--10},
title = {{My awesome research software}},
volume = {1},
year = {2021}
}
Citing a dataset
If your repository contains a datas... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md",
"title": "About CITATION files"
} |
The people you choose as code owners must have write permissions for the repository. When the code owner is a team, that team must be visible and it must have write permissions, even if all the individual members of the team already have write permissions directly, through organization membership, or through another te... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md",
"title": "About code owners"
} |
About READMEs
For more information about providing guidelines for your project, see AUTOTITLE and AUTOTITLE.
A README is often the first item a visitor will see when visiting your repository. README files typically include information on:
What the project does
Why the project is useful
How users can get started with... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md",
"title": "About the repository README file"
} |
uses the open source Linguist library to
determine file languages for syntax highlighting and repository statistics. Language statistics will update after you push changes to your default branch.
Some files are hard to identify, and sometimes projects contain more library and vendor files than their primary code. If yo... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-repository-languages.md",
"title": "About repository languages"
} |
About topics
With topics, you can explore repositories in a particular subject area, find projects to contribute to, and discover new solutions to a specific problem. Topics appear on the main page of a repository. You can click a topic name to see related topics and a list of other repositories classified with that to... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md",
"title": "Classifying your repository with topics"
} |
Until you add an image, repository links expand to show basic information about the repository and the owner's avatar. Adding an image to your repository can help identify your project across various social platforms.
Adding an image to customize the social media preview of your repository
You can upload an image to a... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md",
"title": "Customizing your repository's social media preview"
} |
About FUNDING files
You can configure your sponsor button by editing a FUNDING.yml file in your repository's .github folder, on the default branch. You can configure the button to include sponsored developers in , external funding platforms, or a custom funding URL. For more information about , see AUTOTITLE.
You can a... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md",
"title": "Displaying a sponsor button in your repository"
} |
C nuget
Here's an example FUNDING.yml file:
github: [octocat, surftocat]
patreon: octocat
tidelift: npm/octo-package
custom: ["https://www.paypal.me/octocat", octocat.com]
[!NOTE]
If a custom URL in an array includes :, you must wrap the URL in quotes. For example, "https://www.paypal.me/octocat".
You can create a d... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md",
"title": "Displaying a sponsor button in your repository"
} |
Choosing the right license
We created choosealicense.com, to help you understand how to license your code. A software license tells others what they can and can't do with your source code, so it's important to make an informed decision.
You're under no obligation to choose a license. However, without a license, the def... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md",
"title": "Licensing a repository"
} |
License License keyword
--- ---
Academic Free License v3.0 AFL-3.0
Apache license 2.0 Apache-2.0
Artistic license 2.0 Artistic-2.0
Boost Software License 1.0 BSL-1.0
BSD 2-clause "Simplified" license BSD-2-Clause
BSD 3-clause "New" or "Revised" license BSD-3-Clause
BSD 3-clause Clear license BSD-... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md",
"title": "Licensing a repository"
} |
1. Under "Features," deselect Issues.
If you decide to enable issues again in the future, any issues that were previously added will be available.
1. To restrict issues to collaborators only, in the dropdown under "Issues" select Collaborators only.
In personal repositories, a collaborator is anyone who has been in... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues.md",
"title": "Disabling issues"
} |
Disabling in a repository
When you disable in a repository, linked projects will no longer be available in the repository's Projects tab. Linked projects will remain accessible at an organization or user level.
1. Under "Features," deselect the Projects checkbox. | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-projects-in-a-repository.md",
"title": "Disabling projects in a repository"
} |
1. To disable pull requests entirely, under "Features", deselect Pull requests.
If you decide to enable pull requests again in the future, any pull requests that were previously added will be available.
1. To restrict pull requests to collaborators only, in the dropdown under "Pull requests" select Collaborators only.
... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-pull-requests.md",
"title": "Disabling pull requests"
} |
Enabling or disabling for your repository
1. To disable discussions, under "Features", deselect Discussions.
You can also use organization discussions to facilitate conversations that span multiple repositories in your organization. For more information, see AUTOTITLE.
Further reading
AUTOTITLE
AUTOTITLE | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md",
"title": "Enabling or disabling GitHub Discussions for a repository"
} |
About permissions for your repository
For more information about , see AUTOTITLE.
You can enable for your repository. You can disable for your repository altogether.
Alternatively, you can enable in your repository but limit the actions and reusable workflows a workflow can run.
Managing permissions for your r... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md",
"title": "Managing GitHub Actions settings for a repository"
} |
[!NOTE]
When are enabled or disabled at the enterprise level, it overrides the repository level settings for . For more information, see AUTOTITLE.
About security and analysis settings for your repository
offers a number of different security features that you can enable for your repository to
protect your code fro... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md",
"title": "Managing security and analysis settings for your repository"
} |
Each email notification for a push to a repository lists the new commits and links to a diff containing just those commits. In the email notification you'll see:
The name of the repository where the commit was made
The branch a commit was made in
The SHA1 of the commit, including a link to the diff in
The author o... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md",
"title": "About email notifications for pushes to your repository"
} |
About autolinks
Anyone with admin permissions to a repository can configure autolink references to link issues, pull requests, commit messages, and release descriptions to external third-party services.
Autolink references can now accept alphanumeric characters. When originally introduced, custom autolinks were limited... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md",
"title": "Configuring autolinks to reference external resources"
} |
Repository administrators can change the anonymous Git read access setting for a specific repository if:
A site administrator has enabled private mode and anonymous Git read access.
The repository is public on the enterprise and is not a fork.
A site administrator has not disabled anonymous Git read access for the r... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md",
"title": "Enabling anonymous Git read access for a repository"
} |
About auto-closing issues
By default, merging a linked pull request automatically closes the associated issue. You can override the default behavior by disabling auto-closing.
Enabling or disabling auto-closing of issues
1. Under General, scroll down to the Issues section.
1. Select or deselect Auto-close issues with ... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-auto-closing-issues.md",
"title": "Managing the automatic closing of issues in your repository"
} |
About objects in archives
creates source code archives of your repository in the form of ZIP files and tarballs. People can download these archives on the main page of your repository or as release assets. By default, objects are not included in these archives, only the pointer files to these objects. To improve the... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md",
"title": "Managing Git LFS objects in archives of your repository"
} |
About code review limits
By default, in public repositories, any user can submit reviews that approve or request changes to a pull request.
You can limit which users are able to submit reviews that approve or request changes to pull requests in your public repository. When you enable code review limits, anyone can comm... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-pull-request-reviews-in-your-repository.md",
"title": "Managing pull request reviews in your repository"
} |
About access management for repositories
For each repository that you administer on , you can see an overview of every team or person with access to the repository. From the overview, you can also invite new teams or people, change each team or person's role for the repository, or remove access to the repository.
This ... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md",
"title": "Managing teams and people with access to your repository"
} |
About commit signoffs
Commit signoffs enable users to affirm that a commit complies with the rules and licensing governing a repository. You can enable compulsory commit signoffs on individual repositories for users committing through 's web interface, making signing off on a commit a seamless part of the commit proces... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md",
"title": "Managing the commit signoff policy for your repository"
} |
About management of the default branch name
When you create a new repository on , the repository contains one branch, which is the default branch. You can change the name that uses for the default branch in new repositories you create. For more information about the default branch, see AUTOTITLE.
Setting the default ... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-default-branch-name-for-your-repositories.md",
"title": "Managing the default branch name for your repositories"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.