text stringlengths 12 91.7k | metadata dict |
|---|---|
Overview
By default, codespaces time out after 30 minutes of inactivity. When a codespace times out it is stopped and will no longer incur charges for compute usage.
The personal settings of a user allow them to define their own timeout period for codespaces they create. This may be longer than the default 30-minute p... | {
"source": "github-docs/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md",
"title": "Restricting the idle timeout period"
} |
Overview
By default, if organization members, or collaborators, are permitted to create codespaces that are billable to your organization, they can create multiple such codespaces. The number of organization-billed codespaces someone can create is governed by a limit to the total number of codespaces that they can crea... | {
"source": "github-docs/codespaces/managing-codespaces-for-your-organization/restricting-the-number-of-organization-billed-codespaces-a-user-can-create.md",
"title": "Restricting the number of organization-billed codespaces a user can create"
} |
Overview
users can set a personal retention period of less than 30 days for codespaces they create. For more information, see AUTOTITLE.
As an organization owner, you may want to configure constraints on the maximum retention period for codespaces created for the repositories owned by your organization. This can help ... | {
"source": "github-docs/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md",
"title": "Restricting the retention period for codespaces"
} |
Overview
Typically, within a codespace you are able to forward ports privately (only to yourself), to members of your organization, or publicly (to anyone with the URL). For more information, see AUTOTITLE.
As an organization owner, you may want to configure constraints on the visibility options users can set when forw... | {
"source": "github-docs/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md",
"title": "Restricting the visibility of forwarded ports"
} |
When any member of your organization performs an action related to , you can review the actions in the audit log. For information about accessing the log, see AUTOTITLE.
The audit log includes details such as who performed the action, what the action was, and when the action was performed. For information on actions, ... | {
"source": "github-docs/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-github-codespaces.md",
"title": "Reviewing your organization's audit logs for GitHub Codespaces"
} |
About GPG verification in
After you enable GPG verification, will automatically sign commits you make in , and the commits will have a verified status on . For more information about -signed commits, see AUTOTITLE.
By default, GPG verification is disabled for codespaces you create. If you enable GPG verification, you... | {
"source": "github-docs/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md",
"title": "Managing GPG verification for GitHub Codespaces"
} |
Overview
By default, your codespace is assigned a token scoped with read permission or read and write permission to the repository from which it was created. The scope of this token changes automatically in the following circumstances.
If you create a codespace for a repository to which you only have read access, then... | {
"source": "github-docs/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md",
"title": "Managing access to other repositories within your codespace"
} |
About secrets for
You can add development environment secrets to your personal account that you want to use in your codespaces. For example, you may want to store and access the following sensitive information as secrets:
Access tokens to cloud services
Service principals
Subscription identifiers
Credentials for a... | {
"source": "github-docs/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces.md",
"title": "Managing your account-specific secrets for GitHub Codespaces"
} |
About security logs for
When you perform an action related to in repositories owned by your personal account, you can review the actions in the security log. For information about accessing the log, see AUTOTITLE.
The security log includes details on what action occurred and when you performed it. For information abo... | {
"source": "github-docs/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-github-codespaces.md",
"title": "Reviewing your security logs for GitHub Codespaces"
} |
Overview
If it currently takes more than 2 minutes to create a codespace for a repository, you are likely to benefit from using prebuilds. This is because, with a prebuild, any source code, editor extensions, project dependencies, commands, and configurations have already been downloaded, installed, and applied before ... | {
"source": "github-docs/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds.md",
"title": "About GitHub Codespaces prebuilds"
} |
By default, the workflow for a prebuild configuration can only access its own repository contents. Your project may use additional resources, located elsewhere, to build the development environment.
Allowing a prebuild read access to external resources
You can configure read access to other repositories, with the sa... | {
"source": "github-docs/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories.md",
"title": "Allowing a prebuild to access other repositories"
} |
You can set up a prebuild configuration for the combination of a specific branch of your repository with a specific dev container configuration file.
Any branches created from a prebuild-enabled parent branch will typically also get prebuilds for the same dev container configuration. This is because prebuilds for child... | {
"source": "github-docs/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md",
"title": "Configuring prebuilds"
} |
About managing prebuilds
The prebuilds that you configure for a repository are created and updated using a workflow, managed by the service.
Depending on the settings in a prebuild configuration, the workflow to update the prebuild may be triggered by these events:
Creating or updating the prebuild configuration
Pu... | {
"source": "github-docs/codespaces/prebuilding-your-codespaces/managing-prebuilds.md",
"title": "Managing prebuilds"
} |
Any changes you make to the dev container configuration for a prebuild-enabled branch will result in an update to the codespace configuration and the associated prebuild. It’s therefore important to test such changes in a codespace from a test branch before committing your changes to a branch of your repository that's ... | {
"source": "github-docs/codespaces/prebuilding-your-codespaces/testing-dev-container-changes.md",
"title": "Testing dev container configuration changes on a prebuild-enabled branch"
} |
Introduction
In this guide, you'll create a codespace from a template repository and explore some of the essential features available to you within the codespace. You'll work in the browser version of , which is initially the default editor for . After trying out this quickstart you can use in other editors, and you c... | {
"source": "github-docs/codespaces/quickstart.md",
"title": "Quickstart for GitHub Codespaces"
} |
About private registries and
A registry is a secure space for storing, managing, and fetching container images or other packages. There are many examples of registries, such as:
's , the Azure Container Registry, and DockerHub for container images
The for Node.js packages.
Certain registries, including the , can b... | {
"source": "github-docs/codespaces/reference/allowing-your-codespace-to-access-a-private-registry.md",
"title": "Allowing your codespace to access a private registry"
} |
We work hard to make sure that is always available to you. However, forces beyond our control sometimes impact the service in ways that can cause unplanned service disruptions.
Although disaster recovery scenarios are rare occurrences, we recommend that you prepare for the possibility that there is an outage of an ent... | {
"source": "github-docs/codespaces/reference/disaster-recovery-for-github-codespaces.md",
"title": "Disaster recovery for GitHub Codespaces"
} |
Overview of codespace security
is designed to be security hardened by default. Consequently, you will need to ensure that your software development practices do not risk reducing the security posture of your codespace.
This guide describes the way keeps your development environment secure and provides some of the goo... | {
"source": "github-docs/codespaces/reference/security-in-github-codespaces.md",
"title": "Security in GitHub Codespaces"
} |
is an AI pair programmer that you can use in any codespace that you open in the web client or desktop application. For more information about , see AUTOTITLE.
To start using in , install the extension from the .
To include , or other extensions, in all of your codespaces, enable Settings Sync. For more information, ... | {
"source": "github-docs/codespaces/reference/using-github-copilot-in-github-codespaces.md",
"title": "Using GitHub Copilot in GitHub Codespaces"
} |
About the
The is one of the focal features of and is available for you to use in . The Command Palette allows you to access many commands for and . For more information on using the , see User Interface in the documentation.
Accessing the
You can access the in a number of ways.
<kbdShift</kbd+<kbdCommand</kbd+... | {
"source": "github-docs/codespaces/reference/using-the-vs-code-command-palette-in-codespaces.md",
"title": "Using the Visual Studio Code Command Palette in GitHub Codespaces"
} |
About dev containers
Development containers, or dev containers, are Docker containers that are specifically configured to provide a fully featured development environment. Whenever you work in a codespace, you are using a dev container on a virtual machine.
You can configure the dev container for a repository so that c... | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers.md",
"title": "Introduction to dev containers"
} |
Introduction
This tutorial guide shows you how to set up an example C (.NET) project
Step 1: Open the project in a codespace
1. Go to https://github.com/microsoft/vscode-remote-try-dotnet.
When you create a codespace, your project is created on a remote virtual machine that is dedicated to you. By default, the contai... | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-dotnet-project-for-codespaces.md",
"title": "Setting up a C# (.NET) project for GitHub Codespaces"
} |
Introduction | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-java-project-for-codespaces.md",
"title": "Setting up a Java project for GitHub Codespaces"
} |
This guide shows you how to set up an example Java project
Step 1: Open the project in a codespace
1. Go to https://github.com/microsoft/vscode-remote-try-java.
When you create a codespace, your project is created on a remote virtual machine that is dedicated to you. By default, the container for your codespace has m... | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-java-project-for-codespaces.md",
"title": "Setting up a Java project for GitHub Codespaces"
} |
Introduction
This guide shows you how to set up an example Node.js project
Step 1: Open the project in a codespace
1. Go to https://github.com/microsoft/vscode-remote-try-node.
When you create a codespace, your project is created on a remote virtual machine that is dedicated to you. By default, the container for your... | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-nodejs-project-for-codespaces.md",
"title": "Setting up a Node.js project for GitHub Codespaces"
} |
Introduction | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-php-project-for-codespaces.md",
"title": "Setting up a PHP project for GitHub Codespaces"
} |
This guide shows you how to set up an example PHP project
Step 1: Open the project in a codespace
1. Go to https://github.com/microsoft/vscode-remote-try-php.
When you create a codespace, your project is created on a remote virtual machine that is dedicated to you. By default, the container for your codespace has man... | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-php-project-for-codespaces.md",
"title": "Setting up a PHP project for GitHub Codespaces"
} |
Introduction | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-python-project-for-codespaces.md",
"title": "Setting up a Python project for GitHub Codespaces"
} |
This guide shows you how to set up an example Python project
Step 1: Open the project in a codespace
1. Go to https://github.com/microsoft/vscode-remote-try-python.
When you create a codespace, your project is created on a remote virtual machine that is dedicated to you. By default, the container for your codespace h... | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-python-project-for-codespaces.md",
"title": "Setting up a Python project for GitHub Codespaces"
} |
Use the tabs in this article to display instructions for each of these ways of adding features.
Adding features to a devcontainer.json file
1. Navigate to your repository on , find your devcontainer.json file, and click to edit the file.
If you don't already have a devcontainer.json file, you can create one now. F... | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file.md",
"title": "Adding features to a devcontainer.json file"
} |
Overview
If there's a particular file that's useful for people to see when they create a codespace for your repository, you can set this file to be opened automatically in the web client. You set this up in the dev container configuration file for your repository.
The file, or files, you specify are only opened the fi... | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/automatically-opening-files-in-the-codespaces-for-a-repository.md",
"title": "Automatically opening files in the codespaces for a repository"
} |
Overview
Each codespace that you create is hosted on a separate virtual machine. When you create a codespace from a repository, you can usually choose from different types of virtual machines. Each machine type has different resources (processor cores, memory, storage) and, by default, the machine type with the least r... | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/setting-a-minimum-specification-for-codespace-machines.md",
"title": "Setting a minimum specification for codespace machines"
} |
About recommended secrets
If a project needs user-specific secrets to be set up, you can prompt people to do this when they create a codespace. You do this by adding a setting to a dev container configuration file for the repository.
After you specify recommended secrets, if people have not already created those secret... | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/specifying-recommended-secrets-for-a-repository.md",
"title": "Specifying recommended secrets for a repository"
} |
Overview
You can make it easy for people to work on your repository in a codespace by providing a link to the codespace creation page. One place you might want to do this is in the README file for your repository. For example, you can add the link to an "Open in " badge.
The link to the codespace creation page can incl... | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/facilitating-quick-creation-and-resumption-of-codespaces.md",
"title": "Facilitating quick creation and resumption of codespaces"
} |
Introduction
By setting up a template repository, you can help people get started with your framework, library, or other project in . Users will be able to start working with your template files immediately in a cloud-based development environment, without having to worry about cloning your repository or installing too... | {
"source": "github-docs/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/setting-up-a-template-repository-for-github-codespaces.md",
"title": "Setting up a template repository for GitHub Codespaces"
} |
About the virtual machine host image
A codespace is a development environment provided by a Docker container that runs on a virtual machine (VM). For more information about the relationship of the development container and the VM, see AUTOTITLE.
The VM for a codespace is built using a host image that defines the opera... | {
"source": "github-docs/codespaces/setting-your-user-preferences/choosing-the-stable-or-beta-host-image.md",
"title": "Choosing the stable or beta host image"
} |
By default, are automatically deleted after they have been stopped and have remained inactive for 30 days.
However, because incurs storage charges, you may prefer to reduce the retention period by changing your default period in your personal settings for . For more information about storage charges, see AUTOTITLE.
... | {
"source": "github-docs/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces.md",
"title": "Configuring automatic deletion of your codespaces"
} |
About personalizing
When using any development environment, customizing the settings and tools to your preferences and workflows is an important step. allows for two main ways of personalizing your codespaces.
Settings Sync - You can synchronize your settings between the desktop application and the web client.
Do... | {
"source": "github-docs/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account.md",
"title": "Personalizing GitHub Codespaces for your account"
} |
On the settings page, you can set your editor preference so that when you create a codespace, or open an existing codespace, it is opened in your choice of:
(desktop application)
(web client application)
JupyterLab - the web interface for Project Jupyter
If you want to use as your default editor for , you need to... | {
"source": "github-docs/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces.md",
"title": "Setting your default editor for GitHub Codespaces"
} |
You can manually select the region that your codespaces will be created in, allowing you to meet stringent security and compliance requirements. By default, your region is set automatically, based on your location.
Setting your default region
1. Under "Region", select the setting you want: Set automatically or Set man... | {
"source": "github-docs/codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces.md",
"title": "Setting your default region for GitHub Codespaces"
} |
About the idle timeout
A codespace will stop running after a period of inactivity. By default this period is 30 minutes, but you can specify a longer or shorter default timeout period in your personal settings on . The updated setting will apply to any new codespaces you create. You can also specify a timeout when you ... | {
"source": "github-docs/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces.md",
"title": "Setting your timeout period for GitHub Codespaces"
} |
[!NOTE] The editor is currently in . You can provide feedback in our Discussions. Additionally, the editor is not available on subdomains of , such as octocorp.ghe.com.
About the editor
The editor introduces a lightweight editing experience that runs entirely in your browser. With the editor, you can navigate fil... | {
"source": "github-docs/codespaces/the-githubdev-web-based-editor.md",
"title": "The github.dev web-based editor"
} |
About exporting changes
While using , you may want to export your changes to a branch without launching your codespace. This can be useful when you have hit a spending limit or have a general issue accessing your codespace.
You can export your changes in one of several ways, depending on how you created the codespace. ... | {
"source": "github-docs/codespaces/troubleshooting/exporting-changes-to-a-branch.md",
"title": "Exporting changes to a branch"
} |
Information on is output to various logs:
Codespace logs
Creation logs
Browser console logs (for the web client)
Extension logs are available if you are using in . Click the "" tab above for details.
Codespace logs
Creation logs
Extension logs (for the desktop application)
Browser logs are available if you ar... | {
"source": "github-docs/codespaces/troubleshooting/github-codespaces-logs.md",
"title": "GitHub Codespaces logs"
} |
When you create a codespace for a repository, you can generally use git pull and git push to pull and push changes to that repository without any additional authentication. However, occasionally you may see authentication errors when trying to run these operations.
You may also get errors if you are trying to interact ... | {
"source": "github-docs/codespaces/troubleshooting/troubleshooting-authentication-to-a-repository.md",
"title": "Troubleshooting authentication to a repository"
} |
Creating codespaces
No access to create a codespace
is not available for all repositories. If the options for creating a codespace are not displayed, may not be available for that repository.
If you have remaining monthly included usage of on your personal account, or you have set up a payment method and a spending... | {
"source": "github-docs/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md",
"title": "Troubleshooting creation and deletion of codespaces"
} |
Troubleshooting the web client
If you encounter issues using in a browser that is not Chromium-based, try switching to a Chromium-based browser, such as Google Chrome or Microsoft Edge. Alternatively, check for known issues with your browser in the microsoft/vscode repository by searching for issues labeled with the ... | {
"source": "github-docs/codespaces/troubleshooting/troubleshooting-github-codespaces-clients.md",
"title": "Troubleshooting GitHub Codespaces clients"
} |
If you enable GPG verification, automatically signs your commits in codespaces that you create from selected repositories. For more information, see AUTOTITLE.
If fails to sign a commit, you may see the error message gpg failed to sign the data in the command line or in a pop-up window.
The following sections of thi... | {
"source": "github-docs/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md",
"title": "Troubleshooting GPG verification for GitHub Codespaces"
} |
Personal accounts include a quota of free use of every month.
[!NOTE]
Free use of is included in personal accounts only. It is not included in organization or enterprise accounts.
There are two types of usage: compute and storage. During your monthly billing period, as you use , your compute and storage usage is ... | {
"source": "github-docs/codespaces/troubleshooting/troubleshooting-included-usage.md",
"title": "Getting the most out of your included usage"
} |
You can personalize by using a dotfiles repository on or by using Settings Sync. For more information, see AUTOTITLE.
Troubleshooting dotfiles
If your codespace fails to pick up configuration settings from dotfiles, you should work through the following debugging steps.
1. Enable dotfiles by selecting Automatically ... | {
"source": "github-docs/codespaces/troubleshooting/troubleshooting-personalization-for-codespaces.md",
"title": "Troubleshooting personalization options for GitHub Codespaces"
} |
When an application running inside a codespace outputs a port to the console, detects the localhost URL pattern and automatically forwards the port. For more information, see AUTOTITLE.
If a port is not automatically forwarded, you can forward it manually. For more information, see AUTOTITLE.
If port forwarding is set... | {
"source": "github-docs/codespaces/troubleshooting/troubleshooting-port-forwarding-for-github-codespaces.md",
"title": "Troubleshooting port forwarding for GitHub Codespaces"
} |
For more information about prebuilds, see AUTOTITLE.
Checking whether a codespace was created from a prebuild?
When you create a codespace, you can choose the type of the virtual machine you want to use. If a prebuild is available for the type of virtual machine, " Prebuild ready" is shown next to it.
If you have you... | {
"source": "github-docs/codespaces/troubleshooting/troubleshooting-prebuilds.md",
"title": "Troubleshooting prebuilds"
} |
503 codespace service unavailable
Codespaces are set to stop after 30 minutes without any activity. If you try to interact with a codespace after it has stopped, you may see a 503 service unavailable error.
If a Start button is shown in or in your browser window, click Start to reconnect to the codespace.
Reset your... | {
"source": "github-docs/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md",
"title": "Troubleshooting your connection to GitHub Codespaces"
} |
Before support can help you with problems with codespaces, you need to know the permanent name of the codespace and its codespaces ID (identifier). In addition, support may ask you to share some logs with them. For more information, see AUTOTITLE and AUTOTITLE.
Codespace names
Each codespace has two names: a display n... | {
"source": "github-docs/codespaces/troubleshooting/working-with-support-for-github-codespaces.md",
"title": "Working with support for GitHub Codespaces"
} |
Every repository on comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wik... | {
"source": "github-docs/communities/documenting-your-project-with-wikis/about-wikis.md",
"title": "About wikis"
} |
Adding wiki pages
1. In the upper-right corner of the page, click New Page.
1. Optionally, to write in a format other than Markdown, use the "Edit mode" dropdown to choose a different format.
!Screenshot of the "Create new page" page. The "Edit mode" dropdown is outlined in dark orange.
1. Use the text editor to add... | {
"source": "github-docs/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md",
"title": "Adding or editing wiki pages"
} |
1. Under Features, deselect Restrict editing to collaborators only.
Further reading
AUTOTITLE | {
"source": "github-docs/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis.md",
"title": "Changing access permissions for wikis"
} |
Creating a footer
1. At the bottom of the page, click Add a custom footer.
1. Use the text editor to type the content you want your footer to have.
1. In the "Edit message" field, enter a commit message describing the footer you’re adding.
1. To commit your changes to the wiki, click Save Page.
Creating a sidebar
1. C... | {
"source": "github-docs/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki.md",
"title": "Creating a footer or sidebar for your wiki"
} |
When you turn off a wiki, the content is hidden, but not erased. If you choose to re-enable wikis later, your previous pages will be restored.
1. Under Features, deselect Wikis.
Further reading
AUTOTITLE | {
"source": "github-docs/communities/documenting-your-project-with-wikis/disabling-wikis.md",
"title": "Disabling wikis"
} |
Adding links
You can create links in wikis using one of the following formats. For example:
If your pages are rendered with Markdown, the link syntax is Link Text.
With MediaWiki syntax, the link syntax is [[NameofwikipageLink Text]].
Adding images
Wikis can display PNG, JPEG, and GIF images.
1. Using the wiki sideb... | {
"source": "github-docs/communities/documenting-your-project-with-wikis/editing-wiki-content.md",
"title": "Editing wiki content"
} |
Viewing wiki history
Wiki history includes:
The user who made the change
The commit message they provided
When the change was made
1. Using the wiki sidebar, navigate to the page whose history you want to view.
1. At the top of the wiki, click the revision link.
!Screenshot of the title of a wiki page. The revisi... | {
"source": "github-docs/communities/documenting-your-project-with-wikis/viewing-a-wikis-history-of-changes.md",
"title": "Viewing a wiki's history of changes"
} |
You can block non-members from within your organization's settings or from a specific comment made by a user. When you block a user in a comment, you can choose to send the user a notification explaining that they were blocked and why. Otherwise, the user is not directly notified that you've blocked them. Blocked users... | {
"source": "github-docs/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization.md",
"title": "Blocking a user from your organization"
} |
About blocking users
You can block a user in your account settings or from the user's profile. will not notify the user when you block them. If you want to avoid contributing to the same project as someone you've blocked, you can choose to display a warning on any repositories with prior contributions from a blocked u... | {
"source": "github-docs/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account.md",
"title": "Blocking a user from your personal account"
} |
About reporting abuse or spam
You can report users that have violated 's Community Guidelines or Terms of Service. You can also report issues, pull requests, or comments on issues, pull requests, and commits.
If reported content is enabled for a public repository, you can also report content directly to repository main... | {
"source": "github-docs/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md",
"title": "Reporting abuse or spam"
} |
After unblocking a user from your organization, they'll be able to contribute to your organization's repositories.
If you selected a specific amount of time to block the user, they will be automatically unblocked when that period of time ends. For more information, see AUTOTITLE.
[!TIP]
Any settings that were removed... | {
"source": "github-docs/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md",
"title": "Unblocking a user from your organization"
} |
When you unblock a user, they'll be able to invite you to be a collaborator to their repositories. If they @mention you anywhere on GitHub, you'll receive notifications.
In repositories you own, the user will be able to collaborate normally.
You can unblock a user in your account settings or from the user's profile pag... | {
"source": "github-docs/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-personal-account.md",
"title": "Unblocking a user from your personal account"
} |
1. Under "Blocked users", review the list of users who are blocked from your organization.
Further reading
AUTOTITLE
AUTOTITLE
AUTOTITLE | {
"source": "github-docs/communities/maintaining-your-safety-on-github/viewing-users-who-are-blocked-from-your-organization.md",
"title": "Viewing users who are blocked from your organization"
} |
1. Under "Blocked users", review the list of users you've blocked from your account.
Further reading
AUTOTITLE
AUTOTITLE
AUTOTITLE | {
"source": "github-docs/communities/maintaining-your-safety-on-github/viewing-users-youve-blocked-from-your-personal-account.md",
"title": "Viewing users you've blocked from your personal account"
} |
About archiving pull requests
Archiving a pull request removes it from public view while preserving its history for repository administrators. This provides a safer moderation path when they need to take a pull request out of public view without permanently deleting it.
When a pull request is archived:
The pull reques... | {
"source": "github-docs/communities/moderating-comments-and-conversations/archive-pull-requests.md",
"title": "Archive pull requests"
} |
About temporary interaction limits
Limiting interactions for your personal account enables temporary interaction limits for all public repositories owned by your personal account.
After the duration of your limit passes, users can resume normal activity in your public repositories.
When you enable user-wide activity ... | {
"source": "github-docs/communities/moderating-comments-and-conversations/limiting-interactions-for-your-personal-account.md",
"title": "Limiting interactions for your personal account"
} |
About temporary interaction limits
Limiting interactions in your organization enables temporary interaction limits for all public repositories owned by the organization.
After the duration of your limit passes, users can resume normal activity in your organization's public repositories.
Members of the organization ar... | {
"source": "github-docs/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization.md",
"title": "Limiting interactions in your organization"
} |
About temporary interaction limits
After the duration of your limit passes, users can resume normal activity in your repository.
You can also enable activity limitations on all repositories owned by your personal account or an organization. If a user-wide or organization-wide limit is enabled, you can't limit activity... | {
"source": "github-docs/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md",
"title": "Limiting interactions in your repository"
} |
It's appropriate to lock a conversation when the entire conversation is not constructive or violates your community's code of conduct or 's Community Guidelines. When you lock a conversation, you can also specify a reason, which is publicly visible.
Locking a conversation creates a timeline event that is visible to any... | {
"source": "github-docs/communities/moderating-comments-and-conversations/locking-conversations.md",
"title": "Locking conversations"
} |
Hiding a comment
Organization moderators and anyone with write access to a repository, can hide comments on issues, discussions, pull requests, and commits.
If a comment is off-topic, outdated, or resolved, you may want to hide a comment to keep a discussion focused or make a pull request easier to navigate and review.... | {
"source": "github-docs/communities/moderating-comments-and-conversations/managing-disruptive-comments.md",
"title": "Managing disruptive comments"
} |
You can enable or disable reported content for public repositories owned by an organization.
1. Under "Reported content", select a reporting permissions setting, then click Save.
Prior contributors and collaborators will be selected by default for repositories created after March 3, 2023.
Further reading
AUTOTITL... | {
"source": "github-docs/communities/moderating-comments-and-conversations/managing-how-contributors-report-abuse-in-your-organizations-repository.md",
"title": "Managing how contributors report abuse in your organization's repository"
} |
About management of reported content
Before you can view or manage reported content, you must enable reported content for the repository. For more information, see AUTOTITLE.
You can track, triage, and respond to reports of disruptive content. In the "Abuse reports" list, you can view all reports and navigate directly ... | {
"source": "github-docs/communities/moderating-comments-and-conversations/managing-reported-content-in-your-organizations-repository.md",
"title": "Managing reported content in your organization's repository"
} |
Viewing a comment's edit history details
Anyone with read access to a repository can view a comment's edit history.
1. Navigate to the comment you'd like to view the edit history for.
Deleting sensitive information from a comment's history
Comment authors and anyone with write access to a repository can delete sensiti... | {
"source": "github-docs/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment.md",
"title": "Tracking changes in a comment"
} |
About community management and moderation
also offers tools for repository maintainers to define and enforce higher standards of behavior in their own communities on .
Organization owners can specify organization members as moderators. This gives these members access to moderation features otherwise reserved for organ... | {
"source": "github-docs/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation.md",
"title": "About community management and moderation"
} |
The community profile checklist checks to see if a project includes recommended community health files, such as README, CODEOFCONDUCT, LICENSE, or CONTRIBUTING, in a supported location. For more information, see AUTOTITLE.
Using the community profile checklist as a repository maintainer
As a repository maintainer, you... | {
"source": "github-docs/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md",
"title": "About community profiles for public repositories"
} |
1. In the left sidebar, click Community Standards to show the checklist for the community profile of the repository.
Further reading
AUTOTITLE | {
"source": "github-docs/communities/setting-up-your-project-for-healthy-contributions/accessing-a-projects-community-profile.md",
"title": "Accessing a project's community profile"
} |
A code of conduct defines standards for how to engage in a community. It signals an inclusive environment that respects all contributions. It also outlines procedures for addressing problems between members of your project's community. For more information on why a code of conduct defines standards and expectations for... | {
"source": "github-docs/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md",
"title": "Adding a code of conduct to your project"
} |
If you include a detectable license in your repository, people who visit your repository will see it at the top of the repository page. To read the entire license file, click the license name (for example: github-linguist/linguist).
Open source licenses enable others to freely use, change, and distribute the project in... | {
"source": "github-docs/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md",
"title": "Adding a license to a repository"
} |
To direct people to specific support resources, you can add a SUPPORT file to your repository's root, docs, or .github folder. When someone creates an issue in your repository, they will see a link to your project's SUPPORT file.
You can create default support resources for your organization or personal account. For mo... | {
"source": "github-docs/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md",
"title": "Adding support resources to your project"
} |
About default community health files
Default community health files are a set of predefined files that provide guidance and templates for maintaining a healthy and collaborative open source project. These files help you automate and standardize various aspects of your project's development and community interaction, pr... | {
"source": "github-docs/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md",
"title": "Creating a default community health file"
} |
You can apply the good first issue label to issues in your public repository so that people can find them when searching by labels. For more information about searching by labels, see AUTOTITLE.
uses an algorithm to determine the most approachable issues in each repository and surface them in various places on . Addin... | {
"source": "github-docs/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels.md",
"title": "Encouraging helpful contributions to your project with labels"
} |
About contributing guidelines
To help your project contributors do good work, you can add a file with contribution guidelines to your project repository's root, docs, or .github folder. When someone opens a pull request or creates an issue, they will see a link to that file. The link to the contributing guidelines also... | {
"source": "github-docs/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md",
"title": "Setting guidelines for repository contributors"
} |
After you create issue and pull request templates in your repository, contributors can use the templates to open issues or describe the proposed changes in their pull requests according to the repository's contributing guidelines. For more information about adding contributing guidelines to a repository, see AUTOTITLE.... | {
"source": "github-docs/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md",
"title": "About issue and pull request templates"
} |
<!--UI-LINK: We link to individual anchors within this file from the issue template editor when the given YAML error is thrown. Links to and anchors within this file should be preserved or should be updated in github/github if they are changed --
Required top level key name is missing
The template does not contain a n... | {
"source": "github-docs/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md",
"title": "Common validation errors when creating issue forms"
} |
Creating issue templates
1. In the "Features" section, under Issues, click Set up templates. You may need to enable Issues and refresh the page before you can see the button.
!Screenshot of the "Features" section of a repository's settings, with the "Issues" setting ticked and the green "Set up templates" button vis... | {
"source": "github-docs/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md",
"title": "Configuring issue templates for your repository"
} |
For more information, see AUTOTITLE.
You can create a PULLREQUESTTEMPLATE/ subdirectory in any of the supported folders to contain multiple pull request templates, and use the template query parameter to specify the template that will fill the pull request body. For more information, see AUTOTITLE.
You can create defau... | {
"source": "github-docs/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository.md",
"title": "Creating a pull request template for your repository"
} |
[!NOTE]
's form schema is currently in and subject to change.
About 's form schema
You can use 's form schema to configure forms for supported features. For more information, see AUTOTITLE.
A form is a set of elements for requesting user input. You can configure a form by creating a YAML form definition, which is an... | {
"source": "github-docs/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md",
"title": "Syntax for GitHub's form schema"
} |
About YAML syntax for issue forms
You can create custom issue forms by adding a YAML form definition file to the /.github/ISSUETEMPLATE folder in your repository. You can define different input types, validations, default assignees, and default labels for your issue forms.
When a contributor fills out an issue form, t... | {
"source": "github-docs/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md",
"title": "Syntax for issue forms"
} |
documentation is open source. Anyone can contribute to the docs in the public docs repository: https://github.com/github/docs. employees work on the documentation in a copy of this repository called docs-internal. The two repositories are automatically synced to keep them both up to date with changes merged into the m... | {
"source": "github-docs/contributing/collaborating-on-github-docs/about-contributing-to-github-docs.md",
"title": "About contributing to GitHub Docs"
} |
You can use labels to locate a particular type of issue. The examples below show some commonly used labels that can help you get started. Each label links to a filtered list of open issues in the github/docs repository.
Label Description
--- ---
help wanted Problems or updates that anyone in the community can s... | {
"source": "github-docs/contributing/collaborating-on-github-docs/label-reference.md",
"title": "Label reference"
} |
This article describes the process of creating a topic branch for the documentation repository, committing changes, and pushing your changes back up to the remote repository.
The article assumes you have already cloned the documentation repository locally and you will be making changes on your local computer rather tha... | {
"source": "github-docs/contributing/collaborating-on-github-docs/using-git-on-github-docs.md",
"title": "Using Git on GitHub Docs"
} |
About the content linter
Our content linter enforces style guide rules in our Markdown content.
The linter uses markdownlint as the framework to perform checks, report flaws, and automatically fix content, when possible. This framework flexibly runs specific rules, gives descriptive error messages, and fixes errors. T... | {
"source": "github-docs/contributing/collaborating-on-github-docs/using-the-content-linter.md",
"title": "Using the content linter"
} |
Using the TODOCS placeholder
Sometimes technical writers use placeholders while writing documentation to remind themselves to come back to something later. It's a useful technique, but there's always the possibility that the placeholder will be overlooked and slip into production. At that point, the only way the Docs t... | {
"source": "github-docs/contributing/collaborating-on-github-docs/using-the-todocs-placeholder-to-leave-notes.md",
"title": "Using the TODOCS placeholder to leave notes"
} |
About site structure
The site was originally a Ruby on Rails web application. Some time later it was converted into a static site powered by Jekyll. A few years after that it was migrated to Nanoc, another Ruby static site generator.
Today it's a dynamic Node.js webserver powered by Express, using middleware to suppo... | {
"source": "github-docs/contributing/setting-up-your-environment-to-work-on-github-docs/creating-a-local-environment.md",
"title": "Creating a local environment"
} |
Troubleshooting tests that fail locally but pass in CI
If you run tests locally and get failures in tests/rendering/server.ts around static assets, stylesheets, or the client-side JavaScript bundle, but the same tests pass in CI on a PR, run the command npm run build. This is a one-time command that creates static asse... | {
"source": "github-docs/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment.md",
"title": "Troubleshooting your environment"
} |
About
allows you to work in a development environment that's hosted remotely from your machine. You can get started quickly, without needing to set up the working environment or download files to your local computer.
For more information, see AUTOTITLE.
Working on documentation in a codespace
The following steps ass... | {
"source": "github-docs/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace.md",
"title": "Working on GitHub Docs in a codespace"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.