diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md index 9a40b3f87356..83be6ce74886 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md @@ -78,9 +78,9 @@ An apex domain is configured with an `A`, `ALIAS`, or `ANAME` record through you There are a couple of reasons your site might be automatically disabled. -- If you downgrade from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, any {% data variables.product.prodname_pages %} sites that are currently published from private repositories in your account will be unpublished. For more information, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan)." -- If you transfer a private repository to a personal account that is using {% data variables.product.prodname_free_user %}, the repository will lose access to the {% data variables.product.prodname_pages %} feature, and the currently published {% data variables.product.prodname_pages %} site will be unpublished. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/transferring-a-repository)." +* If you downgrade from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, any {% data variables.product.prodname_pages %} sites that are currently published from private repositories in your account will be unpublished. For more information, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan)." +* If you transfer a private repository to a personal account that is using {% data variables.product.prodname_free_user %}, the repository will lose access to the {% data variables.product.prodname_pages %} feature, and the currently published {% data variables.product.prodname_pages %} site will be unpublished. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/transferring-a-repository)." ## Further reading -- "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages)" +* "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages)" diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index 632233d4e336..cb6a15991e38 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -49,8 +49,8 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom {% data reusables.pages.sidebar-pages %} 1. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file directly to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow, no `CNAME` file is created, so you need to create one manually (containing only a line of text with your custom domain). For more information about your publishing source, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." 1. Navigate to your DNS provider and create either an `ALIAS`, `ANAME`, or `A` record. You can also create `AAAA` records for IPv6 support. If you're implementing IPv6 support, we highly recommend using an `A` record in addition to your `AAAA` record, due to slow adoption of IPv6 globally. {% data reusables.pages.contact-dns-provider %} - - To create an `ALIAS` or `ANAME` record, point your apex domain to the default domain for your site. {% data reusables.pages.default-domain-information %} - - To create `A` records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}. + * To create an `ALIAS` or `ANAME` record, point your apex domain to the default domain for your site. {% data reusables.pages.default-domain-information %} + * To create `A` records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}. ```shell 185.199.108.153 @@ -59,7 +59,7 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom 185.199.111.153 ``` - - To create `AAAA` records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}. + * To create `AAAA` records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}. ```shell 2606:50c0:8000::153 @@ -71,7 +71,7 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} 1. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above. - - For `A` records: + * For `A` records: ```shell $ dig EXAMPLE.COM +noall +answer -t A @@ -81,7 +81,7 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom > EXAMPLE.COM 3600 IN A 185.199.111.153 ``` - - For `AAAA` records: + * For `AAAA` records: ```shell $ dig EXAMPLE.COM +noall +answer -t AAAA @@ -181,4 +181,4 @@ If you get an error about a custom domain being taken, you may need to remove th ## Further reading -- "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages)" +* "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages)" diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md index e871bf56803c..3052ea6e662b 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md @@ -26,10 +26,10 @@ For your site to render at the correct domain, make sure your CNAME file still e Then, make sure the CNAME file is formatted correctly. -- The CNAME filename must be all uppercase. -- The CNAME file can contain only one domain. To point multiple domains to your site, you must set up a redirect through your DNS provider. -- The CNAME file must contain the domain name only. For example, `www.example.com`, `blog.example.com`, or `example.com`. -- The domain name must be unique across all {% data variables.product.prodname_pages %} sites. For example, if another repository's CNAME file contains `example.com`, you cannot use `example.com` in the CNAME file for your repository. +* The CNAME filename must be all uppercase. +* The CNAME file can contain only one domain. To point multiple domains to your site, you must set up a redirect through your DNS provider. +* The CNAME file must contain the domain name only. For example, `www.example.com`, `blog.example.com`, or `example.com`. +* The domain name must be unique across all {% data variables.product.prodname_pages %} sites. For example, if another repository's CNAME file contains `example.com`, you cannot use `example.com` in the CNAME file for your repository. ## DNS misconfiguration @@ -37,17 +37,17 @@ If you have trouble pointing the default domain for your site to your custom dom You can also use one of the following methods to test whether your custom domain's DNS records are configured correctly: -- A CLI tool such as `dig`. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site)". -- An online DNS lookup tool. +* A CLI tool such as `dig`. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site)". +* An online DNS lookup tool. ## Custom domain names that are unsupported If your custom domain is unsupported, you may need to change your domain to a supported domain. You can also contact your DNS provider to see if they offer forwarding services for domain names. Make sure your site does not: -- Use more than one apex domain. For example, both `example.com` and `anotherexample.com`. -- Use more than one `www` subdomain. For example, both `www.example.com` and `www.anotherexample.com`. -- Use both an apex domain and custom subdomain. For example, both `example.com` and `docs.example.com`. +* Use more than one apex domain. For example, both `example.com` and `anotherexample.com`. +* Use more than one `www` subdomain. For example, both `www.example.com` and `www.anotherexample.com`. +* Use both an apex domain and custom subdomain. For example, both `example.com` and `docs.example.com`. The one exception is the `www` subdomain. If configured correctly, the `www` subdomain is automatically redirected to the apex domain. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-an-apex-domain)." diff --git a/content/pages/getting-started-with-github-pages/about-github-pages.md b/content/pages/getting-started-with-github-pages/about-github-pages.md index 83825f506fd4..04bf6e193fd5 100644 --- a/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -80,9 +80,9 @@ For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/ If you're a {% data variables.enterprise.prodname_managed_user %}, your use of {% data variables.product.prodname_pages %} is limited. -- {% data variables.product.prodname_pages %} sites can only be published from repositories owned by organizations. -- {% data variables.product.prodname_pages %} sites are always privately published, and you cannot change this visibility. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)." -- You cannot create an organization site (a site published from a repository named `.github.io`) +* {% data variables.product.prodname_pages %} sites can only be published from repositories owned by organizations. +* {% data variables.product.prodname_pages %} sites are always privately published, and you cannot change this visibility. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)." +* You cannot create an organization site (a site published from a repository named `.github.io`) For more information about {% data variables.product.prodname_emus %}, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." {% endif %} @@ -117,13 +117,13 @@ Using {% data variables.product.prodname_pages %} to create a copy of an existin {% data variables.product.prodname_pages %} sites are subject to the following usage limits: -- {% data variables.product.prodname_pages %} source repositories have a recommended limit of 1 GB.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github#file-and-repository-size-limitations)"{% endif %} -- Published {% data variables.product.prodname_pages %} sites may be no larger than 1 GB. -- {% data variables.product.prodname_pages %} deployments will timeout if they take longer than 10 minutes. +* {% data variables.product.prodname_pages %} source repositories have a recommended limit of 1 GB.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github#file-and-repository-size-limitations)"{% endif %} +* Published {% data variables.product.prodname_pages %} sites may be no larger than 1 GB. +* {% data variables.product.prodname_pages %} deployments will timeout if they take longer than 10 minutes. {% ifversion fpt or ghec %} -- {% data variables.product.prodname_pages %} sites have a _soft_ bandwidth limit of 100 GB per month. -- {% data variables.product.prodname_pages %} sites have a _soft_ limit of 10 builds per hour. This limit does not apply if you build and publish your site with a custom {% data variables.product.prodname_actions %} workflow. -- In order to provide consistent quality of service for all {% data variables.product.prodname_pages %} sites, rate limits may apply. These rate limits are not intended to interfere with legitimate uses of {% data variables.product.prodname_pages %}. If your request triggers rate limiting, you will receive an appropriate response with an HTTP status code of `429`, along with an informative HTML body. +* {% data variables.product.prodname_pages %} sites have a _soft_ bandwidth limit of 100 GB per month. +* {% data variables.product.prodname_pages %} sites have a _soft_ limit of 10 builds per hour. This limit does not apply if you build and publish your site with a custom {% data variables.product.prodname_actions %} workflow. +* In order to provide consistent quality of service for all {% data variables.product.prodname_pages %} sites, rate limits may apply. These rate limits are not intended to interfere with legitimate uses of {% data variables.product.prodname_pages %}. If your request triggers rate limiting, you will receive an appropriate response with an HTTP status code of `429`, along with an informative HTML body. If your site exceeds these usage quotas, we may not be able to serve your site, or you may receive a polite email from {% data variables.contact.github_support %} suggesting strategies for reducing your site's impact on our servers, including putting a third-party content distribution network (CDN) in front of your site, making use of other {% data variables.product.prodname_dotcom %} features such as releases, or moving to a different hosting service that might better fit your needs. @@ -144,5 +144,5 @@ When a {% data variables.product.prodname_pages %} site is visited, the visitor' ## Further reading -- [{% data variables.product.prodname_pages %}](https://github.com/skills/github-pages) on {% data variables.product.prodname_learning %} -- "[AUTOTITLE](/rest/repos#pages)" +* [{% data variables.product.prodname_pages %}](https://github.com/skills/github-pages) on {% data variables.product.prodname_learning %} +* "[AUTOTITLE](/rest/repos#pages)" diff --git a/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md b/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md index b83b1eaf5941..0e5d3e4d88c2 100644 --- a/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md @@ -25,8 +25,8 @@ Access control is available for project sites that are published from a private Privately published sites are available at a different subdomain than publicly published sites. This ensures that your {% data variables.product.prodname_pages %} site is secure from the moment it's published: -- We automatically secure every subdomain of `*.pages.github.io` with a TLS certificate, and enforce HSTS to ensure that browsers always serve the page over HTTPS. -- We use a unique subdomain for the privately published site to ensure that other repositories in your organization cannot publish content on the same origin as the site. This protects your site from "[cookie tossing](https://github.blog/2013-04-09-yummy-cookies-across-domains/)". This is also why we don't host {% data variables.product.prodname_pages %} sites on the `github.com` domain. +* We automatically secure every subdomain of `*.pages.github.io` with a TLS certificate, and enforce HSTS to ensure that browsers always serve the page over HTTPS. +* We use a unique subdomain for the privately published site to ensure that other repositories in your organization cannot publish content on the same origin as the site. This protects your site from "[cookie tossing](https://github.blog/2013-04-09-yummy-cookies-across-domains/)". This is also why we don't host {% data variables.product.prodname_pages %} sites on the `github.com` domain. You can see your site's unique subdomain in the "Pages" tab of your repository settings. If you're using a static site generator configured to build the site with the repository name as a path, you may need to update the settings for the static site generator when changing the site to private. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" or the documentation for your static site generator. diff --git a/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md b/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md index c3186dd862cf..05cee9ea4e88 100644 --- a/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md @@ -35,4 +35,4 @@ shortTitle: Create custom 404 page ## Further reading -- [Front matter](https://jekyllrb.com/docs/frontmatter) in the Jekyll documentation +* [Front matter](https://jekyllrb.com/docs/frontmatter) in the Jekyll documentation diff --git a/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md b/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md index 85d110730317..7151aa9a7686 100644 --- a/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md @@ -64,7 +64,7 @@ To customize your site even more, you can use Jekyll, a static site generator wi ## Further reading -- "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)" -- "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)" -- "[AUTOTITLE](/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites)" +* "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)" +* "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)" +* "[AUTOTITLE](/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites)" diff --git a/content/pages/getting-started-with-github-pages/deleting-a-github-pages-site.md b/content/pages/getting-started-with-github-pages/deleting-a-github-pages-site.md index 0e0c1318a50e..c6f459e08acd 100644 --- a/content/pages/getting-started-with-github-pages/deleting-a-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/deleting-a-github-pages-site.md @@ -15,8 +15,8 @@ shortTitle: Delete a GitHub Pages site ## Deleting your site You can delete your site in two ways: -- Delete the repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/deleting-a-repository)." -- Change the source to the `None` branch. For more information, see [Deleting your site by changing the source](#deleting-your-site-by-changing-the-source) below. +* Delete the repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/deleting-a-repository)." +* Change the source to the `None` branch. For more information, see [Deleting your site by changing the source](#deleting-your-site-by-changing-the-source) below. If you want to remove the current deployment of your site but do not want to delete the site, you can unpublish your site. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site)." diff --git a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md index 7d4954a1ca81..888aed7e1acd 100644 --- a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md +++ b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md @@ -51,10 +51,10 @@ If you enable HTTPS for your {% data variables.product.prodname_pages %} site bu To remove your site's mixed content, make sure all your assets are served over HTTPS by changing `http://` to `https://` in your site's HTML. Assets are commonly found in the following locations: -- If your site uses Jekyll, your HTML files will probably be found in the __layouts_ folder. -- CSS is usually found in the `` section of your HTML file. -- JavaScript is usually found in the `` section or just before the closing `` tag. -- Images are often found in the `` section. +* If your site uses Jekyll, your HTML files will probably be found in the __layouts_ folder. +* CSS is usually found in the `` section of your HTML file. +* JavaScript is usually found in the `` section or just before the closing `` tag. +* Images are often found in the `` section. {% tip %} diff --git a/content/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites.md b/content/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites.md index 9e6bb99899cd..3222c033fe06 100644 --- a/content/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites.md +++ b/content/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites.md @@ -15,13 +15,13 @@ shortTitle: Troubleshoot 404 errors In this guide you'll find common reasons you may be seeing a 404 error while building your {% data variables.product.prodname_pages %} site. -- [{% data variables.product.prodname_dotcom %}'s Status page](#githubs-status-page){% ifversion fpt or ghec %} -- [DNS setup](#dns-setup){% endif %} -- [Browser cache](#browser-cache) -- [`index.html` file](#indexhtml-file) -- [Directory contents](#directory-contents){% ifversion fpt or ghec %} -- [Custom domain](#custom-domain){% endif %} -- [Repository](#repository) +* [{% data variables.product.prodname_dotcom %}'s Status page](#githubs-status-page){% ifversion fpt or ghec %} +* [DNS setup](#dns-setup){% endif %} +* [Browser cache](#browser-cache) +* [`index.html` file](#indexhtml-file) +* [Directory contents](#directory-contents){% ifversion fpt or ghec %} +* [Custom domain](#custom-domain){% endif %} +* [Repository](#repository) ### {% data variables.product.prodname_dotcom %}'s Status page @@ -39,15 +39,15 @@ If your {% data variables.product.prodname_pages %} site is private and you see {% data variables.product.prodname_pages %} will look for an `index.html` file as the entry file for your site. -- Make sure you have an `index.html` file in the repository for your site on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site)." -- The entry file must be at the top level of your chosen publishing source. For example, if your publishing source is the `/docs` directory on the `main` branch, your entry file must be located in the `/docs` directory on a branch called `main`. +* Make sure you have an `index.html` file in the repository for your site on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site)." +* The entry file must be at the top level of your chosen publishing source. For example, if your publishing source is the `/docs` directory on the `main` branch, your entry file must be located in the `/docs` directory on a branch called `main`. If your publishing source is a branch and directory, the entry file must be at the top level of the source directory on the source branch. For example, if your publishing source is the `/docs` directory on the `main` branch, your entry file must be located in the `/docs` directory on a branch called `main`. If your publishing source is a {% data variables.product.prodname_actions %} workflow, the artifact that you deploy must include the entry file at the top level of the artifact. Instead of adding the entry file to your repository, you may choose to have your {% data variables.product.prodname_actions %} workflow generate your entry file when the workflow runs. -- The name of the `index.html` file is case sensitive. For example, `Index.html` will not work. -- The name of the file should be `index.html`, not `index.HTML` or any other variation. +* The name of the `index.html` file is case sensitive. For example, `Index.html` will not work. +* The name of the file should be `index.html`, not `index.HTML` or any other variation. ### Directory contents @@ -59,15 +59,15 @@ Check that your directory contents are in the root directory. If you're using a custom domain, make sure it's set up correctly. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)." -- The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} -- If you are able to access your landing page, but encounter broken links throughout, it is likely because you either didn't have a custom domain name before or are reverting back from having a custom domain name. In such cases, changing the routing path does not initiate a rebuild of the page. The recommended solution is to ensure that your site rebuilds automatically when adding or removing a custom domain name. This may involve configuring a commit author and modifying the custom domain name settings.{% endif %} +* The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} +* If you are able to access your landing page, but encounter broken links throughout, it is likely because you either didn't have a custom domain name before or are reverting back from having a custom domain name. In such cases, changing the routing path does not initiate a rebuild of the page. The recommended solution is to ensure that your site rebuilds automatically when adding or removing a custom domain name. This may involve configuring a commit author and modifying the custom domain name settings.{% endif %} ### Repository Check whether your repository meets the following requirements. -- The branch you are using to publish your site must be the `main` or default branch. -- The repository must have a commit pushed to it by someone with admin permissions for the repository, such as the repository owner. -- Switching the repository's visibility from public to private or vice versa will change the URL of your {% data variables.product.prodname_pages %} site, which will result in broken links until the site is rebuilt. +* The branch you are using to publish your site must be the `main` or default branch. +* The repository must have a commit pushed to it by someone with admin permissions for the repository, such as the repository owner. +* Switching the repository's visibility from public to private or vice versa will change the URL of your {% data variables.product.prodname_pages %} site, which will result in broken links until the site is rebuilt. If you are still receiving a 404 error, start a [{% data variables.product.prodname_github_community %} discussion](https://github.com/orgs/community/discussions/categories/pages) in the Pages category. diff --git a/content/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages.md b/content/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages.md index e0e1f7f46d44..5ad847952d1b 100644 --- a/content/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages.md +++ b/content/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages.md @@ -43,10 +43,10 @@ To use the action in your current workflow place this snippet under `jobs`. The `deploy-pages` action handles the necessary setup for deploying artifacts. To ensure proper functionality, the following requirements should be met: -- The job must have a minimum of `pages: write` and `id-token: write` permissions. -- The `needs` parameter must be set to the `id` of the build step. Not setting this parameter may result in an independent deployment that continuously searches for an artifact that hasn't been created. -- An `environment` must be established to enforce branch/deployment protection rules. The default environment is `github-pages`. -- To specify the URL of the page as an output, utilize the `url:` field. +* The job must have a minimum of `pages: write` and `id-token: write` permissions. +* The `needs` parameter must be set to the `id` of the build step. Not setting this parameter may result in an independent deployment that continuously searches for an artifact that hasn't been created. +* An `environment` must be established to enforce branch/deployment protection rules. The default environment is `github-pages`. +* To specify the URL of the page as an output, utilize the `url:` field. For more information, see the [`deploy-pages`](https://github.com/marketplace/actions/deploy-github-pages-site) action. diff --git a/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md b/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md index f528f1730512..36fe771d85b7 100644 --- a/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md +++ b/content/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md @@ -22,5 +22,5 @@ Use the `https://` read-only URL for your submodules, including nested submodule ## Further reading -- "[Git Tools - Submodules](https://git-scm.com/book/en/Git-Tools-Submodules)" from the _Pro Git_ book -- "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites)" +* "[Git Tools - Submodules](https://git-scm.com/book/en/Git-Tools-Submodules)" from the _Pro Git_ book +* "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites)" diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index c67e25f0265f..5641e8a4a833 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -56,10 +56,10 @@ kramdown: ``` By default, Jekyll doesn't build files or folders that: -- Are located in a folder called `/node_modules` or `/vendor` -- Start with `_`, `.`, or `#` -- End with `~` -- Are excluded by the `exclude` setting in your configuration file +* Are located in a folder called `/node_modules` or `/vendor` +* Start with `_`, `.`, or `#` +* End with `~` +* Are excluded by the `exclude` setting in your configuration file If you want Jekyll to process any of these files, you can use the `include` setting in your configuration file. @@ -85,15 +85,15 @@ You can override any of your theme's defaults by editing the theme's files. For You can download or create Jekyll plugins to extend the functionality of Jekyll for your site. For example, the [jemoji](https://github.com/jekyll/jemoji) plugin lets you use {% data variables.product.prodname_dotcom %}-flavored emoji in any page on your site the same way you would on {% data variables.product.prodname_dotcom %}. For more information, see "[Plugins](https://jekyllrb.com/docs/plugins/)" in the Jekyll documentation. {% data variables.product.prodname_pages %} uses plugins that are enabled by default and cannot be disabled: -- [`jekyll-coffeescript`](https://github.com/jekyll/jekyll-coffeescript) -- [`jekyll-default-layout`](https://github.com/benbalter/jekyll-default-layout) -- [`jekyll-gist`](https://github.com/jekyll/jekyll-gist) -- [`jekyll-github-metadata`](https://github.com/jekyll/github-metadata) -- [`jekyll-optional-front-matter`](https://github.com/benbalter/jekyll-optional-front-matter) -- [`jekyll-paginate`](https://github.com/jekyll/jekyll-paginate) -- [`jekyll-readme-index`](https://github.com/benbalter/jekyll-readme-index) -- [`jekyll-titles-from-headings`](https://github.com/benbalter/jekyll-titles-from-headings) -- [`jekyll-relative-links`](https://github.com/benbalter/jekyll-relative-links) +* [`jekyll-coffeescript`](https://github.com/jekyll/jekyll-coffeescript) +* [`jekyll-default-layout`](https://github.com/benbalter/jekyll-default-layout) +* [`jekyll-gist`](https://github.com/jekyll/jekyll-gist) +* [`jekyll-github-metadata`](https://github.com/jekyll/github-metadata) +* [`jekyll-optional-front-matter`](https://github.com/benbalter/jekyll-optional-front-matter) +* [`jekyll-paginate`](https://github.com/jekyll/jekyll-paginate) +* [`jekyll-readme-index`](https://github.com/benbalter/jekyll-readme-index) +* [`jekyll-titles-from-headings`](https://github.com/benbalter/jekyll-titles-from-headings) +* [`jekyll-relative-links`](https://github.com/benbalter/jekyll-relative-links) You can enable additional plugins by adding the plugin's gem to the `plugins` setting in your `_config.yml` file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 287884877915..0dd777b20532 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -19,9 +19,9 @@ shortTitle: Jekyll build errors for Pages ## About Jekyll build errors If you are publishing from a branch, sometimes {% data variables.product.prodname_pages %} will not attempt to build your site after you push changes to your site's publishing source.{% ifversion fpt or ghec %} -- The person who pushed the changes hasn't verified their email address. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address)."{% endif %} -- You're pushing with a deploy key. If you want to automate pushes to your site's repository, you can set up a machine user instead. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#machine-users)." -- You're using a CI service that isn't configured to build your publishing source. For example, Travis CI won't build the `gh-pages` branch unless you add the branch to a safe list. For more information, see "[Customizing the build](https://docs.travis-ci.com/user/customizing-the-build/#safelisting-or-blocklisting-branches)" on Travis CI, or your CI service's documentation. +* The person who pushed the changes hasn't verified their email address. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address)."{% endif %} +* You're pushing with a deploy key. If you want to automate pushes to your site's repository, you can set up a machine user instead. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#machine-users)." +* You're using a CI service that isn't configured to build your publishing source. For example, Travis CI won't build the `gh-pages` branch unless you add the branch to a safe list. For more information, see "[Customizing the build](https://docs.travis-ci.com/user/customizing-the-build/#safelisting-or-blocklisting-branches)" on Travis CI, or your CI service's documentation. {% note %} @@ -33,8 +33,8 @@ If you are publishing from a branch, sometimes {% data variables.product.prodnam If Jekyll does attempt to build your site and encounters an error, you will receive a build error message. {% else %} If Jekyll does attempt to build your site and encounters an error, you will receive a build error message. There are two main types of Jekyll build error messages. -- A "Page build warning" message means your build completed successfully, but you may need to make changes to prevent future problems. -- A "Page build failed" message means your build failed to complete. If Jekyll is able to detect a reason for the failure, you'll see a descriptive error message. +* A "Page build warning" message means your build completed successfully, but you may need to make changes to prevent future problems. +* A "Page build failed" message means your build failed to complete. If Jekyll is able to detect a reason for the failure, you'll see a descriptive error message. {% endif %} For more information about troubleshooting build errors, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites)." diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md index 9c747158b53d..584b4e524ee8 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md @@ -28,8 +28,8 @@ People with write permissions for a repository can add a theme to a {% data vari 1. Navigate to __config.yml_. {% data reusables.repositories.edit-file %} 1. Add a new line to the file for the theme name. - - To use a supported theme, type `theme: THEME-NAME`, replacing _THEME-NAME_ with the name of the theme as shown in the `_config.yml` of the theme's repository (most themes follow a `jekyll-theme-NAME` naming convention). For a list of supported themes, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site. For example, to select the Minimal theme, type `theme: jekyll-theme-minimal`. - - To use any other Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, type `remote_theme: THEME-NAME`, replacing THEME-NAME with the name of the theme as shown in the README of the theme's repository. + * To use a supported theme, type `theme: THEME-NAME`, replacing _THEME-NAME_ with the name of the theme as shown in the `_config.yml` of the theme's repository (most themes follow a `jekyll-theme-NAME` naming convention). For a list of supported themes, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site. For example, to select the Minimal theme, type `theme: jekyll-theme-minimal`. + * To use any other Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, type `remote_theme: THEME-NAME`, replacing THEME-NAME with the name of the theme as shown in the README of the theme's repository. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} @@ -72,4 +72,4 @@ People with write permissions for a repository can add a theme to a {% data vari ## Further reading -- "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)" +* "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)" diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md index da2b767b8e36..e4cf8caafb63 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md @@ -33,5 +33,5 @@ You can use {% data variables.product.prodname_dotcom %} Flavored Markdown with ## Further reading -- [kramdown Documentation](https://kramdown.gettalong.org/documentation.html) -- [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/) +* [kramdown Documentation](https://kramdown.gettalong.org/documentation.html) +* [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/) diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md index 157c0ac99c46..4854ded6183e 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md @@ -21,8 +21,8 @@ Anyone with read permissions for a repository can test a {% data variables.produ ## Prerequisites Before you can use Jekyll to test a site, you must: -- Install [Jekyll](https://jekyllrb.com/docs/installation/). -- Create a Jekyll site. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll)." +* Install [Jekyll](https://jekyllrb.com/docs/installation/). +* Create a Jekyll site. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll)." {% data reusables.pages.recommend-bundler %} @@ -64,9 +64,9 @@ Jekyll is an active open source project that is updated frequently. If the `gith {% data reusables.command_line.open_the_multi_os_terminal %} 1. Update the `github-pages` gem. - - If you installed Bundler, run `bundle update github-pages`. - - If you don't have Bundler installed, run `gem update github-pages`. + * If you installed Bundler, run `bundle update github-pages`. + * If you don't have Bundler installed, run `gem update github-pages`. ## Further reading -- [{% data variables.product.prodname_pages %}](https://jekyllrb.com/docs/github-pages/) in the Jekyll documentation +* [{% data variables.product.prodname_pages %}](https://jekyllrb.com/docs/github-pages/) in the Jekyll documentation diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md index e1ca95920238..c88c1c8e4a57 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md @@ -40,10 +40,10 @@ shortTitle: Troubleshoot Jekyll errors If Jekyll encounters an error building your {% data variables.product.prodname_pages %} site locally or on {% data variables.product.product_name %}, you can use error messages to troubleshoot. For more information about error messages and how to view them, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites)." If you received a generic error message, check for common issues. -- You're using unsupported plugins. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins)."{% ifversion fpt or ghec %} -- Your repository has exceeded our repository size limits. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github)"{% endif %} -- You changed the `source` setting in your `_config.yml` file. If you publish your site from a branch, {% data variables.product.prodname_pages %} overrides this setting during the build process. -- A filename in your published files contains a colon (`:`) which is not supported. +* You're using unsupported plugins. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins)."{% ifversion fpt or ghec %} +* Your repository has exceeded our repository size limits. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github)"{% endif %} +* You changed the `source` setting in your `_config.yml` file. If you publish your site from a branch, {% data variables.product.prodname_pages %} overrides this setting during the build process. +* A filename in your published files contains a colon (`:`) which is not supported. If you received a specific error message, review the troubleshooting information for the error message below. @@ -136,9 +136,9 @@ Then, make sure the file in the error message uses valid Markdown syntax. For mo This error means that you have chosen the `docs` folder on a branch as your publishing source, but there is no `docs` folder in the root of your repository on that branch. To troubleshoot, if your `docs` folder was accidentally moved, try moving the `docs` folder back to the root of your repository on the branch you chose for your publishing source. If the `docs` folder was accidentally deleted, you can either: -- Use Git to revert or undo the deletion. For more information, see "[git-revert](https://git-scm.com/docs/git-revert.html)" in the Git documentation. -- Create a new `docs` folder in the root of your repository on the branch you chose for your publishing source and add your site's source files to the folder. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." -- Change your publishing source. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." +* Use Git to revert or undo the deletion. For more information, see "[git-revert](https://git-scm.com/docs/git-revert.html)" in the Git documentation. +* Create a new `docs` folder in the root of your repository on the branch you chose for your publishing source and add your site's source files to the folder. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." +* Change your publishing source. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." ## Missing submodule diff --git a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts.md b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts.md index 4b33a5f8f284..21ce3b4fa725 100644 --- a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts.md +++ b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts.md @@ -22,8 +22,8 @@ You must resolve all merge conflicts before you can merge a pull request on {% d To resolve a merge conflict, you must manually edit the conflicted file to select the changes that you want to keep in the final merge. There are a couple of different ways to resolve a merge conflict: -- If your merge conflict is caused by competing line changes, such as when people make different changes to the same line of the same file on different branches in your Git repository, you can resolve it on {% data variables.product.product_name %} using the conflict editor. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)." -- For all other types of merge conflicts, you must resolve the merge conflict in a local clone of the repository and push the change to your branch on {% data variables.product.product_name %}. You can use the command line or a tool like [{% data variables.product.prodname_desktop %}](https://desktop.github.com/) to push the change. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)." +* If your merge conflict is caused by competing line changes, such as when people make different changes to the same line of the same file on different branches in your Git repository, you can resolve it on {% data variables.product.product_name %} using the conflict editor. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)." +* For all other types of merge conflicts, you must resolve the merge conflict in a local clone of the repository and push the change to your branch on {% data variables.product.product_name %}. You can use the command line or a tool like [{% data variables.product.prodname_desktop %}](https://desktop.github.com/) to push the change. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)." If you have a merge conflict on the command line, you cannot push your local changes to {% data variables.product.product_name %} until you resolve the merge conflict locally on your computer. If you try merging branches on the command line that have a merge conflict, you'll get an error message. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)." @@ -36,7 +36,7 @@ $ git merge BRANCH-NAME ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)" diff --git a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md index 1010d3151bef..5fbad0ccff22 100644 --- a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md +++ b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md @@ -63,4 +63,4 @@ If a site administrator disables the merge conflict editor for pull requests bet ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" diff --git a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md index 7aeec557dd28..21a6ab1e43a4 100644 --- a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md +++ b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md @@ -144,5 +144,5 @@ You can now merge the branches on the command line or [push your changes to your ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)" diff --git a/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md b/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md index a44aa5c4cc18..075c201d2cad 100644 --- a/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md +++ b/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md @@ -30,8 +30,8 @@ You can see the overall state of the last commit to a branch on your repository' There are two types of status checks on {% data variables.product.product_name %}: -- Checks -- Commit statuses +* Checks +* Commit statuses _Checks_ are different from _commit statuses_ in that they provide line annotations, more detailed messaging, and are only available for use with {% data variables.product.prodname_github_apps %}. @@ -67,7 +67,7 @@ You can also skip workflow runs triggered by the `push` and `pull_request` event Alternatively, to skip or request _all_ checks for your commit, add one of the following trailer lines to the end of your commit message: -- To _skip checks_ for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by `skip-checks: true`: +* To _skip checks_ for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by `skip-checks: true`: ```shell $ git commit -m "Update README @@ -76,7 +76,7 @@ Alternatively, to skip or request _all_ checks for your commit, add one of the f skip-checks: true" ``` -- To _request_ checks for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by `request-checks: true`: +* To _request_ checks for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by `request-checks: true`: ```shell $ git commit -m "Refactor usability tests diff --git a/content/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md b/content/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md index 34764a2145c2..994f45836945 100644 --- a/content/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md +++ b/content/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md @@ -31,6 +31,6 @@ In the shared repository model, collaborators are granted push access to a singl ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)" diff --git a/content/pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests.md b/content/pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests.md index 20e8fb562d89..0b9310f12c8a 100644 --- a/content/pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests.md +++ b/content/pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests.md @@ -26,9 +26,9 @@ Review, build, and test your own pull request before submitting it. This will al Write clear titles and descriptions for your pull requests so that reviewers can quickly understand what the pull request does. In the pull request body, include: -- the purpose of the pull request -- an overview of what changed -- links to any additional context such as tracking issues or previous conversations +* the purpose of the pull request +* an overview of what changed +* links to any additional context such as tracking issues or previous conversations To help reviewers, share the type of feedback you need. For example, do you need a quick look or a deeper critique? diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md index c13f6eaab6e2..ddcf485360a1 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md @@ -56,14 +56,14 @@ Because this commit is only on the base branch and not the head branch, the comm {% data reusables.pull_requests.rebase_and_merge_summary %} You aren't able to automatically rebase and merge on {% data variables.location.product_location %} when: -- The pull request has merge conflicts. -- Rebasing the commits from the base branch into the head branch runs into conflicts. -- Rebasing the commits is considered "unsafe," such as when a rebase is possible without merge conflicts but would produce a different result than a merge would. +* The pull request has merge conflicts. +* Rebasing the commits from the base branch into the head branch runs into conflicts. +* Rebasing the commits is considered "unsafe," such as when a rebase is possible without merge conflicts but would produce a different result than a merge would. If you still want to rebase the commits but can't rebase and merge automatically on {% data variables.location.product_location %} you must: -- Rebase the topic branch (or head branch) onto the base branch locally on the command line -- [Resolve any merge conflicts on the command line](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line). -- Force-push the rebased commits to the pull request's topic branch (or remote head branch). +* Rebase the topic branch (or head branch) onto the base branch locally on the command line +* [Resolve any merge conflicts on the command line](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line). +* Force-push the rebased commits to the pull request's topic branch (or remote head branch). Anyone with write permissions in the repository, can then [merge the changes](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request) using the rebase and merge button on {% data variables.location.product_location %}. @@ -71,9 +71,9 @@ Anyone with write permissions in the repository, can then [merge the changes](/p A pull request can be merged automatically if its head branch is directly or indirectly merged into the base branch externally. In other words, if the head branch's tip commit becomes reachable from the tip of the target branch. For example: -- Branch `main` is at commit **C**. -- Branch `feature` has been branched off of `main` and is currently at commit **D**. This branch has a pull request targeting `main`. -- Branch `feature_2` is branched off of `feature` and is now at commit **E**. This branch also has a pull request targeting `main`. +* Branch `main` is at commit **C**. +* Branch `feature` has been branched off of `main` and is currently at commit **D**. This branch has a pull request targeting `main`. +* Branch `feature_2` is branched off of `feature` and is now at commit **E**. This branch also has a pull request targeting `main`. If pull request **E** --> `main` is merged first, pull request **D** --> `main` will be marked as merged _automatically_ because all of the commits from `feature` are now reachable from `main`. Merging `feature_2` into `main` and pushing `main` to the server from the command line will mark _both_ pull requests as merged. @@ -85,5 +85,5 @@ Pull requests that are merged indirectly are marked as `merged` even if [branch ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)" diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md index 43b598a550ef..abddb3379be5 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md @@ -35,7 +35,7 @@ product: '{% data reusables.gated-features.merge-queue %}' 1. Click **Merge when ready** to add the pull request to the merge queue. Alternatively, if you are an administrator, you can: - - Directly merge the pull request by checking **Merge without waiting for requirements to be met ({% ifversion bypass-branch-protections %}bypass branch protections{% else %}administrators only{% endif %})**, if allowed by branch protection settings, and follow the standard flow. + * Directly merge the pull request by checking **Merge without waiting for requirements to be met ({% ifversion bypass-branch-protections %}bypass branch protections{% else %}administrators only{% endif %})**, if allowed by branch protection settings, and follow the standard flow. ![Screenshot of the merge queue options for a pull request.](/assets/images/help/pull_requests/merge-queue-options.png) @@ -88,15 +88,15 @@ You can view the merge queue for a base branch in various places on {% data vari {% endwebui %} -- On the **Branches** page for the repository. We recommend you use this route if you don't have or don't know about a pull request already in a queue, and if you want to see what's in that queue. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository)." +* On the **Branches** page for the repository. We recommend you use this route if you don't have or don't know about a pull request already in a queue, and if you want to see what's in that queue. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository)." ![Screenshot of the "Branches" page for a repository. A link, labeled "33 pull requests queued to merge," is outlined in dark orange.](/assets/images/help/pull_requests/merge-queue-branches-page.png) -- On the pull request page when merge queue is required for merging, scroll to the bottom of the timeline and click the **merge queue** link. +* On the pull request page when merge queue is required for merging, scroll to the bottom of the timeline and click the **merge queue** link. ![Screenshot of the merge queue message at the bottom of a pull request. The "merge queue" link is outlined in dark orange.](/assets/images/help/pull_requests/merge-queue-link.png) -- The merge queue view shows the pull requests that are currently in the queue, with your pull requests clearly marked. +* The merge queue view shows the pull requests that are currently in the queue, with your pull requests clearly marked. ![Screenshot of the merge queue.](/assets/images/help/pull_requests/merge-queue-view.png) diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md index 7c65b3f9a426..91b0cb43a186 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md @@ -52,13 +52,13 @@ If you decide you don't want the changes in a topic branch to be merged to the u 1. In the "Pull Requests" list, click the pull request you'd like to merge. 1. Scroll down to the bottom of the pull request. Depending on the merge options enabled for your repository, you can: - - [Merge all of the commits into the base branch](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges) by clicking **Merge pull request**. If the **Merge pull request** option is not shown, click the merge dropdown menu and select **Create a merge commit**. + * [Merge all of the commits into the base branch](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges) by clicking **Merge pull request**. If the **Merge pull request** option is not shown, click the merge dropdown menu and select **Create a merge commit**. ![Screenshot of the merge options for a pull request. The arrow to expand the dropdown is outlined in dark orange.](/assets/images/help/pull_requests/merge-pull-request-options.png) - - [Squash the commits into one commit](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-pull-request-commits) by clicking the merge dropdown menu, selecting **Squash and merge** and then clicking **Squash and merge**. + * [Squash the commits into one commit](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-pull-request-commits) by clicking the merge dropdown menu, selecting **Squash and merge** and then clicking **Squash and merge**. - - [Rebase the commits individually onto the base branch](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#rebase-and-merge-your-pull-request-commits) by clicking the merge dropdown menu, selecting **Rebase and merge** and then clicking **Rebase and merge**. + * [Rebase the commits individually onto the base branch](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#rebase-and-merge-your-pull-request-commits) by clicking the merge dropdown menu, selecting **Rebase and merge** and then clicking **Rebase and merge**. {% note %} @@ -102,7 +102,7 @@ gh pr merge 523 --squash --body "my squash commit" --delete-branch ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request)" -- "[AUTOTITLE](/desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch)" using {% data variables.product.prodname_desktop %} -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request)" +* "[AUTOTITLE](/desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch)" using {% data variables.product.prodname_desktop %} +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)" diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md index 09e239232c39..8bed600b6c53 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md @@ -23,8 +23,8 @@ Reverting a pull request on {% data variables.product.product_name %} creates a **Note:** You may need to revert the individual commits in your pull request if either of the following is true. -- Reverting the pull request causes merge conflicts -- The original pull request was not originally merged on {% data variables.product.product_name %}. For example, someone could have merged the pull request using a fast-forward merge on the command line. +* Reverting the pull request causes merge conflicts +* The original pull request was not originally merged on {% data variables.product.product_name %}. For example, someone could have merged the pull request using a fast-forward merge on the command line. For more information about using Git to manually revert individual commits, see [Git revert](https://git-scm.com/docs/git-revert.html) in the Git documentation. diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md index 0598d57e8053..658dbfe19ac6 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md @@ -67,15 +67,15 @@ To see if your pull request can be merged, look in the merge box at the bottom o When a branch is protected: -- You won't be able to delete or force push to the branch. -- If required status checks are enabled on the branch, you won't be able to merge changes into the branch until all of the required CI tests pass. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." -- If required pull request reviews are enabled on the branch, you won't be able to merge changes into the branch until all requirements in the pull request review policy have been met. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)." -- If required review from a code owner is enabled on a branch, and a pull request modifies code that has an owner, a code owner must approve the pull request before it can be merged. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." -- If required commit signing is enabled on a branch, you won't be able to push any commits to the branch that are not signed and verified. For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification)" and "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-signed-commits)." -- If you use {% data variables.product.prodname_dotcom %}'s conflict editor to fix conflicts for a pull request that you created from a protected branch, {% data variables.product.prodname_dotcom %} helps you to create an alternative branch for the pull request, so that your resolution of the conflicts can be merged. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)." +* You won't be able to delete or force push to the branch. +* If required status checks are enabled on the branch, you won't be able to merge changes into the branch until all of the required CI tests pass. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." +* If required pull request reviews are enabled on the branch, you won't be able to merge changes into the branch until all requirements in the pull request review policy have been met. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)." +* If required review from a code owner is enabled on a branch, and a pull request modifies code that has an owner, a code owner must approve the pull request before it can be merged. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." +* If required commit signing is enabled on a branch, you won't be able to push any commits to the branch that are not signed and verified. For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification)" and "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-signed-commits)." +* If you use {% data variables.product.prodname_dotcom %}'s conflict editor to fix conflicts for a pull request that you created from a protected branch, {% data variables.product.prodname_dotcom %} helps you to create an alternative branch for the pull request, so that your resolution of the conflicts can be merged. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)." ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" -- "[AUTOTITLE](/get-started/learning-about-github/github-glossary#branch)" in the {% data variables.product.prodname_dotcom %} glossary -- "[Branches in a Nutshell](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell)" in the Git documentation +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" +* "[AUTOTITLE](/get-started/learning-about-github/github-glossary#branch)" in the {% data variables.product.prodname_dotcom %} glossary +* "[Branches in a Nutshell](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell)" in the Git documentation diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md index e0ae809945f9..699c21b60bd5 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md @@ -34,10 +34,10 @@ Rather than viewing the commits themselves, you can view the proposed changes as {% endtip %} You have several options for viewing a diff: -- The unified view shows updated and existing content together in a linear view. -- The split view shows old content on one side and new content on the other side. -- The rich diff view shows a preview of how the changes will look once the pull request is merged. -- The source view shows the changes in source without the formatting of the rich diff view. +* The unified view shows updated and existing content together in a linear view. +* The split view shows old content on one side and new content on the other side. +* The rich diff view shows a preview of how the changes will look once the pull request is merged. +* The source view shows the changes in source without the formatting of the rich diff view. You can also choose to ignore whitespace changes to get a more accurate view of the substantial changes in a pull request. @@ -49,8 +49,8 @@ To simplify reviewing changes in a large pull request, you can filter the diff t ## Reasons diffs will not display -- You've exceeded the total limit of files or certain file types. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/repository-limits#diff-limits)." -- Your file matches a rule in the repository's _.gitattributes_ file to block that file from displaying by default. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github)." +* You've exceeded the total limit of files or certain file types. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/repository-limits#diff-limits)." +* Your file matches a rule in the repository's _.gitattributes_ file to block that file from displaying by default. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github)." ## Three-dot and two-dot Git diff comparisons @@ -88,5 +88,5 @@ To avoid getting confused, merge the base branch (for example, `main`) into your ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md index 2a80c8069fc1..dbd5a35d6431 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md @@ -22,8 +22,8 @@ A pull request is a proposal to merge a set of changes from one branch into anot {% note %} **Note:** When working with pull requests, keep the following in mind: -- If you're working in the [shared repository model](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models), we recommend that you use a topic branch for your pull request. While you can send pull requests from any branch or commit, with a topic branch you can push follow-up commits if you need to update your proposed changes. -- Be very careful when force pushing commits to a pull request. Force pushing changes the repository history and can corrupt your pull request. If other collaborators branch the project before a force push, the force push may overwrite commits that collaborators based their work on. +* If you're working in the [shared repository model](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models), we recommend that you use a topic branch for your pull request. While you can send pull requests from any branch or commit, with a topic branch you can push follow-up commits if you need to update your proposed changes. +* Be very careful when force pushing commits to a pull request. Force pushing changes the repository history and can corrupt your pull request. If other collaborators branch the project before a force push, the force push may overwrite commits that collaborators based their work on. {% endnote %} @@ -48,8 +48,8 @@ After you're happy with the proposed changes, you can merge the pull request. If {% tip %} **Tips:** -- To toggle between collapsing and expanding all outdated review comments in a pull request, hold down OptionAltAlt and click **Show outdated** or **Hide outdated**. For more shortcuts, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)." -- You can squash commits when merging a pull request to gain a more streamlined view of changes. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." +* To toggle between collapsing and expanding all outdated review comments in a pull request, hold down OptionAltAlt and click **Show outdated** or **Hide outdated**. For more shortcuts, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)." +* You can squash commits when merging a pull request to gain a more streamlined view of changes. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." {% endtip %} @@ -67,12 +67,12 @@ When you create a pull request, you can choose to create a pull request that is The compare and pull request pages use different methods to calculate the diff for changed files: -- Compare pages show the diff between the tip of the head ref and the current common ancestor (that is, the merge base) of the head and base ref. -- Pull request pages show the diff between the tip of the head ref and the common ancestor of the head and base ref at the time when the pull request was created. Consequently, the merge base used for the comparison might be different. +* Compare pages show the diff between the tip of the head ref and the current common ancestor (that is, the merge base) of the head and base ref. +* Pull request pages show the diff between the tip of the head ref and the common ancestor of the head and base ref at the time when the pull request was created. Consequently, the merge base used for the comparison might be different. ## Further reading -- "[AUTOTITLE](/get-started/learning-about-github/github-glossary#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request)" +* "[AUTOTITLE](/get-started/learning-about-github/github-glossary#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request)" diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.md index 3cc84faceba2..30c568be5777 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.md @@ -40,6 +40,6 @@ shortTitle: Change the base branch ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md index 7732971c265b..fa4902c0f0c0 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md @@ -46,4 +46,4 @@ You can convert a pull request to a draft at any time. For example, if you accid ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md index 570b9b811524..2fbe918b8023 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md @@ -15,10 +15,10 @@ topics: shortTitle: Commit to PR branch from fork --- You can only make commits on pull request branches that: -- are opened in a repository that you have push access to and that were created from a fork of that repository -- are on a user-owned fork -- have permission granted from the pull request creator -- don't have [branch restrictions](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#restrict-who-can-push-to-matching-branches) that will prevent you from committing +* are opened in a repository that you have push access to and that were created from a fork of that repository +* are on a user-owned fork +* have permission granted from the pull request creator +* don't have [branch restrictions](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#restrict-who-can-push-to-matching-branches) that will prevent you from committing Only the user who created the pull request can give you permission to push commits to the user-owned fork. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)." @@ -101,4 +101,4 @@ Your new commits will be reflected on the original pull request on {% data varia ## Further Reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork.md index d3f1d92bb299..03afe3cf9376 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork.md @@ -18,9 +18,9 @@ shortTitle: Create a PR from a fork If your pull request compares your topic branch with a branch in the upstream repository as the base branch, then your topic branch is also called the "compare branch" of the pull request. For example: -- Your topic branch (also known as “feature branch”) is the branch where you’re making your changes in your forked repository (e.g. `my-topic-branch`). -- The base branch is the branch in the upstream (central) repository that you want to merge your changes into (e.g. `main`). -- The pull request compares the changes proposed by the topic branch (`my-topic-branch`) with the base branch (`main`), so `my-topic-branch` is known as the “compare branch”. +* Your topic branch (also known as “feature branch”) is the branch where you’re making your changes in your forked repository (e.g. `my-topic-branch`). +* The base branch is the branch in the upstream (central) repository that you want to merge your changes into (e.g. `main`). +* The pull request compares the changes proposed by the topic branch (`my-topic-branch`) with the base branch (`main`), so `my-topic-branch` is known as the “compare branch”. For more information about pull request branches, including examples, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#changing-the-branch-range-and-destination-repository)." @@ -49,5 +49,5 @@ For more information about pull request branches, including examples, see "[AUTO ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)" diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md index 4571e4848830..826b88f91591 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md @@ -39,8 +39,8 @@ When you change any of the information in the branch range, the Commit and Files {% tip %} **Tips**: -- Using the compare view, you can set up comparisons across any timeframe. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits)." -- Project maintainers can add a pull request template for a repository. Templates include prompts for information in the body of a pull request. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)." +* Using the compare view, you can set up comparisons across any timeframe. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits)." +* Project maintainers can add a pull request template for a repository. Templates include prompts for information in the body of a pull request. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)." {% endtip %} @@ -174,10 +174,10 @@ For more information on creating pull requests in {% data variables.product.prod ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request)" -- "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board#adding-issues-and-pull-requests-to-a-project-board-from-the-sidebar)" -- "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)" -- "[AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)" -- "[AUTOTITLE](/get-started/writing-on-github)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request)" +* "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board#adding-issues-and-pull-requests-to-a-project-board-from-the-sidebar)" +* "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)" +* "[AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)" +* "[AUTOTITLE](/get-started/writing-on-github)" diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md index ff1d7247eaf7..71c2b915bb99 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md @@ -34,8 +34,8 @@ You can create a branch in different ways on {% data variables.product.product_n ![Screenshot of the "Branches" page for a repository. A green button, labeled "New branch", is highlighted with an orange outline.](/assets/images/help/branches/new-branch-button.png) 1. Under "Branch name", type a name for the branch. 1. Under "Branch source", choose a source for your branch. - - If your repository is a fork, select the repository dropdown menu and click your fork or the upstream repository. - - Select the branch dropdown menu and click a branch. + * If your repository is a fork, select the repository dropdown menu and click your fork or the upstream repository. + * Select the branch dropdown menu and click a branch. 1. Click **Create branch**. ### Creating a branch using the branch dropdown @@ -91,6 +91,6 @@ For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-re ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)" -- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository)" -- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)" +* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository)" +* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request)" diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch.md index dde05a20a8c1..70b36326481f 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch.md @@ -17,9 +17,9 @@ Before merging your pull requests, other changes may get merged into the base br You can update a pull request's head branch from the command line or the pull request page. The **Update branch** button is displayed when all of these are true: -- There are no merge conflicts between the pull request branch and the base branch. -- The pull request branch is not up to date with the base branch. -- The base branch requires branches to be up to date before merging or the setting to always suggest updating branches is enabled. +* There are no merge conflicts between the pull request branch and the base branch. +* The pull request branch is not up to date with the base branch. +* The base branch requires branches to be up to date before merging or the setting to always suggest updating branches is enabled. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)" and "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches)." @@ -32,16 +32,16 @@ From the pull request page you can update your pull request's branch using a tra {% data reusables.repositories.sidebar-pr %} 1. In the "Pull requests" list, click the pull request you'd like to update. 1. In the merge section near the bottom of the page, you can: - - Click **Update branch** to perform a traditional merge. + * Click **Update branch** to perform a traditional merge. ![Screenshot of the merge section for a pull request.](/assets/images/help/pull_requests/pull-request-update-branch-with-dropdown.png) - - Click the update branch drop down menu, click **Update with rebase**, and then click **Rebase branch** to update by rebasing on the base branch. + * Click the update branch drop down menu, click **Update with rebase**, and then click **Rebase branch** to update by rebasing on the base branch. ![Screenshot of the merge section for a pull request. The dropdown menu is expanded, showing "Update with merge commit" and "Update with rebase" options.](/assets/images/help/pull_requests/pull-request-update-branch-rebase-option.png) ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork)" diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md index dd6ebefc76b7..f785019ca323 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md @@ -46,4 +46,4 @@ You can request a review from either a suggested or specific person. Suggested r ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)" diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md index 8786e3827e38..5c68871fa13b 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md @@ -29,9 +29,9 @@ For an introduction to requesting and providing pull request reviews, see the [R {% ifversion fpt or ghec %}You can schedule reminders for pull requests that need to be reviewed. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team)."{% endif %} A review has three possible statuses: -- **Comment**: Submit general feedback without explicitly approving the changes or requesting additional changes. -- **Approve**: Submit feedback and approve merging the changes proposed in the pull request. -- **Request changes**: Submit feedback that must be addressed before the pull request can be merged. +* **Comment**: Submit general feedback without explicitly approving the changes or requesting additional changes. +* **Approve**: Submit feedback and approve merging the changes proposed in the pull request. +* **Request changes**: Submit feedback that must be addressed before the pull request can be merged. {% data reusables.repositories.request-changes-tips %} @@ -59,6 +59,6 @@ You can view all of the reviews a pull request has received in the Conversation ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review)" -- "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review)" +* "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)" diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md index 778db49179cf..1bc941808288 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md @@ -39,5 +39,5 @@ You can comment on a pull request, approve the changes, or request improvements ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md index 22f6c57e0370..569cf2c55842 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md @@ -36,8 +36,8 @@ To reply to an existing line {% ifversion pull-request-comment-on-file %}or file {% tip %} **Tips:** -- Pull request comments support the same [formatting](/get-started/writing-on-github) as regular comments on {% data variables.product.product_name %}, such as @mentions, emoji, and references. -- You can add reactions to comments in pull requests in the **Files changed** tab. +* Pull request comments support the same [formatting](/get-started/writing-on-github) as regular comments on {% data variables.product.product_name %}, such as @mentions, emoji, and references. +* You can add reactions to comments in pull requests in the **Files changed** tab. {% endtip %} @@ -60,6 +60,6 @@ Anyone watching the pull request or repository will receive a notification of yo ## Further reading -- "[AUTOTITLE](/get-started/writing-on-github)" +* "[AUTOTITLE](/get-started/writing-on-github)" {% ifversion fpt or ghec %}- "[AUTOTITLE](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" {% endif %} diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review.md index c576ba7e4d33..f2716555f45c 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review.md @@ -33,6 +33,6 @@ This changes the status of the review to a review comment. When you dismiss a re ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" -- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" +* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging)" diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md index 38046c1af4c7..2b2897f817fd 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md @@ -59,5 +59,5 @@ You can filter files in a pull request by file extension type, such as `.html` o ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request)" diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md index c22beec7a06b..b778f98c8149 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md @@ -17,11 +17,11 @@ shortTitle: Methods & functions Anyone with read access to a repository can see a summary list of the functions and methods changes in certain files of a pull request. The summary list of methods and functions is created from these supported file types: -- Go -- JavaScript (includes TypeScript, Flow, and other types of JavaScript) -- PHP -- Python -- Ruby +* Go +* JavaScript (includes TypeScript, Flow, and other types of JavaScript) +* PHP +* Python +* Ruby {% data reusables.repositories.sidebar-pr %} 1. In the list of pull requests, click the pull request where you'd like to find the changed functions and methods. @@ -42,5 +42,5 @@ The summary list of methods and functions is created from these supported file t ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request)" diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request.md index 9f6f6a3e7bef..61a28b355b1c 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request.md @@ -25,11 +25,11 @@ Each person who suggested a change included in the commit will be a co-author of {% data reusables.repositories.sidebar-pr %} 1. In the list of pull requests, click the pull request you'd like to apply a suggested change to. 1. Navigate to the first suggested change you'd like to apply. - - To apply the change in its own commit, click **Commit suggestion**. + * To apply the change in its own commit, click **Commit suggestion**. ![Screenshot of a review comment with a suggestion. The "Commit suggestion" option is outlined in dark orange.](/assets/images/help/pull_requests/commit-suggestion-button.png) - - To add the suggestion to a batch of changes, click **Add suggestion to batch**. Continue to add the suggested changes you want to include in a single commit. When you've finished adding suggested changes, click **Commit suggestions**. + * To add the suggestion to a batch of changes, click **Add suggestion to batch**. Continue to add the suggested changes you want to include in a single commit. When you've finished adding suggested changes, click **Commit suggestions**. ![Screenshot of a review comment with a suggestion. The "Add suggestion to batch" option is outlined in dark orange.](/assets/images/help/pull_requests/add-suggestion-to-batch.png) @@ -46,8 +46,8 @@ If someone suggests changes to your pull request and the changes are out of the ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)" -- "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)" +* "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)" diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md index b845b85d7551..1ea882d158ac 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md @@ -68,17 +68,17 @@ You can configure the {% data variables.dependency-review.action_name %} to bett Other information includes: - - The version, or version range, of the new, updated, or deleted dependency. - - For a specific version of a dependency: - - The age of that release of the dependency. - - The number of projects that are dependent on this software. This information is taken from the dependency graph. Checking the number of dependents can help you avoid accidentally adding the wrong dependency. - - The license used by this dependency, if this information is available. This is useful if you want to avoid code with certain licenses being used in your project. + * The version, or version range, of the new, updated, or deleted dependency. + * For a specific version of a dependency: + * The age of that release of the dependency. + * The number of projects that are dependent on this software. This information is taken from the dependency graph. Checking the number of dependents can help you avoid accidentally adding the wrong dependency. + * The license used by this dependency, if this information is available. This is useful if you want to avoid code with certain licenses being used in your project. Where a dependency has a known vulnerability, the warning message includes: - - A brief description of the vulnerability. - - A Common Vulnerabilities and Exposures (CVE) or {% data variables.product.prodname_security_advisories %} (GHSA) identification number. You can click this ID to find out more about the vulnerability. - - The severity of the vulnerability. - - The version of the dependency in which the vulnerability was fixed. If you are reviewing a pull request for someone, you might ask the contributor to update the dependency to the patched version, or a later release. + * A brief description of the vulnerability. + * A Common Vulnerabilities and Exposures (CVE) or {% data variables.product.prodname_security_advisories %} (GHSA) identification number. You can click this ID to find out more about the vulnerability. + * The severity of the vulnerability. + * The version of the dependency in which the vulnerability was fixed. If you are reviewing a pull request for someone, you might ask the contributor to update the dependency to the patched version, or a later release. {% data reusables.repositories.return-to-source-diff %} diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md index cb1a6effbde3..400e94d58f21 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md @@ -109,14 +109,14 @@ After you've finished reviewing all the files you want in the pull request, subm {% data reusables.repositories.review-summary-comment %} 1. Select the type of review you'd like to leave: - - Select **Comment** to leave general feedback without explicitly approving the changes or requesting additional changes. - - Select **Approve** to submit your feedback and approve merging the changes proposed in the pull request. - - Select **Request changes** to submit feedback that must be addressed before the pull request can be merged. + * Select **Comment** to leave general feedback without explicitly approving the changes or requesting additional changes. + * Select **Approve** to submit your feedback and approve merging the changes proposed in the pull request. + * Select **Request changes** to submit feedback that must be addressed before the pull request can be merged. {% data reusables.repositories.submit-review %} {% data reusables.repositories.request-changes-tips %} ## Further reading -- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging)" -- "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)" +* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging)" +* "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)" diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review.md index 7b830660eb48..8a6f57a64133 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review.md @@ -26,6 +26,6 @@ When you view a full review, you'll see the same version of the pull request as ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" -- "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" +* "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests)" diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md index 34d4865ae4c7..5f1564bad954 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md @@ -46,14 +46,14 @@ If you want to create a new repository from the contents of an existing reposito Forking a repository is similar to duplicating a repository, with the following differences. -- You can use a pull request to suggest changes from your fork to the upstream repository. -- You can bring changes from the upstream repository to your fork by synchronizing your fork with the upstream repository. -- Forks have their own members, branches, tags, labels, policies, issues, pull requests, discussions, actions, projects, and wikis. -- Forks inherit the restrictions of their upstream repositories. For example, branch protection rules cannot be passed down if the upstream repository belongs to an organization on a {% data variables.product.prodname_free_team %} plan. +* You can use a pull request to suggest changes from your fork to the upstream repository. +* You can bring changes from the upstream repository to your fork by synchronizing your fork with the upstream repository. +* Forks have their own members, branches, tags, labels, policies, issues, pull requests, discussions, actions, projects, and wikis. +* Forks inherit the restrictions of their upstream repositories. For example, branch protection rules cannot be passed down if the upstream repository belongs to an organization on a {% data variables.product.prodname_free_team %} plan. ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)" -- [Open Source Guides](https://opensource.guide/){% ifversion fpt or ghec %} -- [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %} +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)" +* [Open Source Guides](https://opensource.guide/){% ifversion fpt or ghec %} +* [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %} diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md index 77a1c2153ac5..64d65eb7b49a 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md @@ -54,17 +54,17 @@ For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-me If you work with forks, or if you're the owner of a repository or organization that allows forking, it's important to be aware of the following security considerations. -- Forks have their own permissions separate from the upstream repository. -- The owners of a repository that has been forked have read permission to all forks in the repository's fork network. -- Organization owners of a repository that has been forked have admin permission to forks created in personal user namespaces, including the ability to delete the fork and its branches. -- Organization owners of a repository that has been forked have read permission to forks created in organizations, but do not have the ability to delete the fork or its branches. -- Forks created in another organization will not be deleted when individual access is removed from the upstream repository. -- Commits to any repository in a fork network can be accessed from any repository in the same fork network, including the upstream repository. +* Forks have their own permissions separate from the upstream repository. +* The owners of a repository that has been forked have read permission to all forks in the repository's fork network. +* Organization owners of a repository that has been forked have admin permission to forks created in personal user namespaces, including the ability to delete the fork and its branches. +* Organization owners of a repository that has been forked have read permission to forks created in organizations, but do not have the ability to delete the fork or its branches. +* Forks created in another organization will not be deleted when individual access is removed from the upstream repository. +* Commits to any repository in a fork network can be accessed from any repository in the same fork network, including the upstream repository. ### About forks within an organization Forks within the same organization copy the collaborators and team settings of their upstream repositories. If a repository is owned by an organization: -- That organization controls the permissions of its forks. -- Any teams from the upstream permission structure that exist and are visible in the target organization or user namespace will have their permissions copied. -- Admin permissions remain with the upstream owner, except when a user forks into a different organization. -- If that repository is forked to a user namespace, the organization maintains admin permissions and any teams with access maintain access. +* That organization controls the permissions of its forks. +* Any teams from the upstream permission structure that exist and are visible in the target organization or user namespace will have their permissions copied. +* Admin permissions remain with the upstream owner, except when a user forks into a different organization. +* If that repository is forked to a user namespace, the organization maintains admin permissions and any teams with access maintain access. diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md index e9bfd0889cde..4213653412e8 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md @@ -41,4 +41,4 @@ You can set commit permissions when you first create a pull request from a fork. ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork)" diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/detaching-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/detaching-a-fork.md index d239c44a3843..daceb936241b 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/detaching-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/detaching-a-fork.md @@ -20,8 +20,8 @@ The new repository will no longer automatically sync with changes from the origi **Notes:** -- The new repository will not retain any of its issues, pull requests, wikis, stars, watchers, comments, child forks, or other metadata that may currently be associated with your current fork. -- All commit metadata will be preserved. Commits may become eligible to be counted as contributions, if they meet certain criteria. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)." +* The new repository will not retain any of its issues, pull requests, wikis, stars, watchers, comments, child forks, or other metadata that may currently be associated with your current fork. +* All commit metadata will be preserved. Commits may become eligible to be counted as contributions, if they meet certain criteria. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)." {% endnote %} diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md index 4112379629e1..c6f8d218ed1e 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md @@ -28,9 +28,9 @@ topics: For example, you can use forks to propose changes related to fixing a bug. Rather than logging an issue for a bug you have found, you can: -- Fork the repository. -- Make the fix. -- Submit a pull request to the project owner. +* Fork the repository. +* Make the fix. +* Submit a pull request to the project owner. ### Use someone else's project as a starting point for your own idea. @@ -157,10 +157,10 @@ When you fork a project in order to propose changes to the upstream repository, {% data reusables.repositories.copy-clone-url %} {% data reusables.command_line.open_the_multi_os_terminal %} 1. Change directories to the location of the fork you cloned. - - To go to your home directory, type just `cd` with no other text. - - To list the files and folders in your current directory, type `ls`. - - To go into one of your listed directories, type `cd YOUR-LISTED-DIRECTORY`. - - To go up one directory, type `cd ..`. + * To go to your home directory, type just `cd` with no other text. + * To list the files and folders in your current directory, type `ls`. + * To go into one of your listed directories, type `cd YOUR-LISTED-DIRECTORY`. + * To go up one directory, type `cd ..`. 1. Type `git remote -v` and press **Enter**. You will see the current configured remote repository for your fork. ```shell @@ -211,8 +211,8 @@ gh repo fork REPOSITORY --remote-name "main-remote-repo" You can make any changes to a fork, including: -- **Creating branches:** [_Branches_](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) allow you to build new features or test out ideas without putting your main project at risk. -- **Opening pull requests:** If you want to contribute back to the upstream repository, you can send a request to the original author to pull your fork into their repository by submitting a [pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests). +* **Creating branches:** [_Branches_](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) allow you to build new features or test out ideas without putting your main project at risk. +* **Opening pull requests:** If you want to contribute back to the upstream repository, you can send a request to the original author to pull your fork into their repository by submitting a [pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests). ## Find another repository to fork @@ -226,10 +226,10 @@ Fork a repository to start contributing to a project. {% data reusables.reposito You have now forked a repository, practiced cloning your fork, and configured an upstream repository. -- For more information about cloning the fork and syncing the changes in a forked repository from your computer, see "[AUTOTITLE](/get-started/getting-started-with-git/set-up-git)." +* For more information about cloning the fork and syncing the changes in a forked repository from your computer, see "[AUTOTITLE](/get-started/getting-started-with-git/set-up-git)." -- You can also create a new repository where you can put all your projects and share the code on {% data variables.product.prodname_dotcom %}. {% data reusables.getting-started.create-a-repository %} +* You can also create a new repository where you can put all your projects and share the code on {% data variables.product.prodname_dotcom %}. {% data reusables.getting-started.create-a-repository %} -- {% data reusables.getting-started.being-social %} +* {% data reusables.getting-started.being-social %} -- {% data reusables.support.connect-in-the-forum-bootcamp %} +* {% data reusables.support.connect-in-the-forum-bootcamp %} diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md index e5748d8c824c..5e518304bf00 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md @@ -65,8 +65,8 @@ If you change the visibility of an internal repository and then delete the repos ## Further reading -- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" -- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)" -- "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" -- "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-forking-private-or-internal-repositories)" +* "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" +* "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)" +* "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" +* "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-forking-private-or-internal-repositories)" diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md index 7702352a1395..987019888e98 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md @@ -67,4 +67,4 @@ You can use the file tree to navigate between files in a commit. ## Further reading -- "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#about-commits)" on {% data variables.product.prodname_desktop %} +* "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#about-commits)" on {% data variables.product.prodname_desktop %} diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md index cbd682ea7e81..e7049d5ce04f 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md @@ -24,9 +24,9 @@ If the commit only exists in your local repository and has not been pushed to {% 1. On the command line, navigate to the repository that contains the commit you want to amend. 1. Type `git commit --amend` and press **Enter**. 1. In your text editor, edit the commit message, and save the commit. - - You can add a co-author by adding a trailer to the commit. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors)." + * You can add a co-author by adding a trailer to the commit. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors)." {% ifversion fpt or ghec %} - - You can create commits on behalf of your organization by adding a trailer to the commit. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization)." + * You can create commits on behalf of your organization by adding a trailer to the commit. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization)." {% endif %} The new commit and message will appear on {% data variables.location.product_location %} the next time you push. @@ -126,4 +126,4 @@ If you have included sensitive information in a commit message, force pushing a ## Further reading -- "[AUTOTITLE](/authentication/managing-commit-signature-verification/signing-commits)" +* "[AUTOTITLE](/authentication/managing-commit-signature-verification/signing-commits)" diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md index 412447466270..2ed6d72eeb3b 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md @@ -13,12 +13,12 @@ shortTitle: On behalf of an organization To create commits on behalf of an organization: -- You must be a member of the organization indicated in the trailer -- You must sign the commit -- Your commit email and the organization email must be in a domain verified by the organization -- Your commit message must end with the commit trailer `on-behalf-of: @org ` - - `org` is the organization's login - - `name@organization.com` is in the organization's domain +* You must be a member of the organization indicated in the trailer +* You must sign the commit +* Your commit email and the organization email must be in a domain verified by the organization +* Your commit message must end with the commit trailer `on-behalf-of: @org ` + * `org` is the organization's login + * `name@organization.com` is in the organization's domain Organizations can use the `name@organization.com` email as a public point of contact for open source efforts. @@ -62,7 +62,7 @@ The new commit, message, and badge will appear on {% data variables.location.pro ## Further reading -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile)" -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)" -- "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors)" -- "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)" +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile)" +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)" +* "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors)" +* "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)" diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md index a765861c17b0..dd60e7639b78 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md @@ -24,8 +24,8 @@ For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-manag {% tip %} **Tip:** You can help a co-author find their preferred email address by sharing this information: -- To find your {% data variables.product.product_name %}-provided `no-reply` email, navigate to your email settings page under "Keep my email address private." -- To find the email you used to configure Git on your computer, run `git config user.email` on the command line. +* To find your {% data variables.product.product_name %}-provided `no-reply` email, navigate to your email settings page under "Keep my email address private." +* To find the email you used to configure Git on your computer, run `git config user.email` on the command line. {% endtip %} @@ -82,8 +82,8 @@ The new commit and message will appear on {% data variables.location.product_loc ## Further reading {% ifversion ghes %} -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile)" -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)"{% endif %} -- "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors)" -- "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)" -- "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#4-write-a-commit-message-and-push-your-changes)" in the {% data variables.product.prodname_desktop %} documentation +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile)" +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)"{% endif %} +* "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors)" +* "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)" +* "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#4-write-a-commit-message-and-push-your-changes)" in the {% data variables.product.prodname_desktop %} documentation diff --git a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md index e8f5bec2659d..e9d8859ca2ea 100644 --- a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md +++ b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md @@ -26,9 +26,9 @@ However, when you view the commit on {% data variables.location.product_location There are several possible explanations: -- The local repository is out of date. -- The branch that contains the commit was deleted, so the commit is no longer referenced. -- Someone force pushed over the commit. +* The local repository is out of date. +* The branch that contains the commit was deleted, so the commit is no longer referenced. +* Someone force pushed over the commit. ## The local repository is out of date @@ -87,5 +87,5 @@ Avoid force pushing to a repository unless absolutely necessary. This is especia ## Further reading -- ["Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) -- ["Data Recovery" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Internals-Maintenance-and-Data-Recovery) +* ["Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) +* ["Data Recovery" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Internals-Maintenance-and-Data-Recovery) diff --git a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md index c86ff92f8b38..f6bbea8f9235 100644 --- a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md +++ b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md @@ -36,9 +36,9 @@ If your commits are not linked to any user, the commit author's name will not be {% data reusables.repositories.navigate-to-commit %} 1. To read a message about why the commit is not linked, hover over the blue {% octicon "question" aria-label="Question mark" %} to the right of the username. - - **Unrecognized author (with email address)** If you see this message with an email address, the address you used to author the commit is not connected to your account on {% data variables.product.product_name %}. To link your commits, [add the email address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account). If the email address has a Gravatar associated with it, the Gravatar will be displayed next to the commit, rather than the default gray Octocat. - - **Unrecognized author (no email address)** If you see this message without an email address, you used a generic email address that can't be connected to your account on {% data variables.product.product_name %}. You will need to [set your commit email address in Git](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked. - - **Invalid email** The email address in your local Git configuration settings is either blank or not formatted as an email address. You will need to [set your commit email address in Git](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked. + * **Unrecognized author (with email address)** If you see this message with an email address, the address you used to author the commit is not connected to your account on {% data variables.product.product_name %}. To link your commits, [add the email address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account). If the email address has a Gravatar associated with it, the Gravatar will be displayed next to the commit, rather than the default gray Octocat. + * **Unrecognized author (no email address)** If you see this message without an email address, you used a generic email address that can't be connected to your account on {% data variables.product.product_name %}. You will need to [set your commit email address in Git](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked. + * **Invalid email** The email address in your local Git configuration settings is either blank or not formatted as an email address. You will need to [set your commit email address in Git](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked. {% warning %} @@ -48,4 +48,4 @@ If your local Git configuration contained a generic email address, or an email a ## Further reading -- "[AUTOTITLE](/search-github/searching-on-github/searching-commits)" +* "[AUTOTITLE](/search-github/searching-on-github/searching-commits)" diff --git a/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md b/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md index 72c66fff94de..555e652ba402 100644 --- a/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md +++ b/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md @@ -71,4 +71,4 @@ You can compare a single commit in Git to the commit's predecessors using two ty ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request)" diff --git a/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/differences-between-commit-views.md b/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/differences-between-commit-views.md index 1d539150ecf4..4e23c58c6bfc 100644 --- a/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/differences-between-commit-views.md +++ b/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/differences-between-commit-views.md @@ -13,8 +13,8 @@ shortTitle: Commit views --- On {% data variables.product.product_name %}, you can see the commit history of a repository by: -- Navigating directly to [the commits page](https://github.com/mozilla/rust/commits/master) of a repository -- Clicking on a file, then clicking **History**, to get to [the commit history for a specific file](https://github.com/mozilla/rust/commits/master/README.md) +* Navigating directly to [the commits page](https://github.com/mozilla/rust/commits/master) of a repository +* Clicking on a file, then clicking **History**, to get to [the commit history for a specific file](https://github.com/mozilla/rust/commits/master/README.md) These two commit views may show _different_ information at times. The history for a single file may omit commits found on the repository's commit history. @@ -34,5 +34,5 @@ For more information on how Git considers commit history, see [the "History Simp ## Further reading -- "[AUTOTITLE](/authentication/managing-commit-signature-verification/signing-commits)" -- "[AUTOTITLE](/search-github/searching-on-github/searching-commits)" +* "[AUTOTITLE](/authentication/managing-commit-signature-verification/signing-commits)" +* "[AUTOTITLE](/search-github/searching-on-github/searching-commits)" diff --git a/content/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md b/content/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md index 8fb1bd1c055c..800890bf0e9f 100644 --- a/content/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md +++ b/content/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md @@ -16,8 +16,8 @@ shortTitle: Archive content & data {% data variables.product.product_name %} 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](/free-pro-team@latest/site-policy/content-removal-policies/dmca-takedown-policy) for content in a repository. -- We determine that a repository's content violates our [Community Guidelines](/free-pro-team@latest/site-policy/github-terms/github-community-guidelines) or [Terms of Service](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service). +* We receive a [DMCA Takedown Notice](/free-pro-team@latest/site-policy/content-removal-policies/dmca-takedown-policy) for content in a repository. +* We determine that a repository's content violates our [Community Guidelines](/free-pro-team@latest/site-policy/github-terms/github-community-guidelines) or [Terms of Service](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service). Academics and researchers can reference this information in data management plans. diff --git a/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md b/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md index 566cd6b9bbf9..19e8a6dbd92f 100644 --- a/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md +++ b/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md @@ -19,9 +19,9 @@ To make your repositories easier to reference in academic literature, you can cr {% tip %} **Tips:** -- Zenodo can only access public repositories, so make sure the repository you want to archive is [public](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility). -- If you want to archive a repository that belongs to an organization, the organization owner may need to [approve access](/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization) for the Zenodo application. -- Make sure to include a [license](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) in your repository so readers know how they can reuse your work. +* Zenodo can only access public repositories, so make sure the repository you want to archive is [public](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility). +* If you want to archive a repository that belongs to an organization, the organization owner may need to [approve access](/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization) for the Zenodo application. +* Make sure to include a [license](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) in your repository so readers know how they can reuse your work. {% endtip %} diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md index 71a95468b20b..bf562305cdcf 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md @@ -32,9 +32,9 @@ The default merge method creates a merge commit. You can prevent anyone from pus {% data reusables.pull_requests.squash_and_merge_summary %} Before enabling squashing commits, consider these disadvantages: -- You lose information about when specific changes were originally made and who authored the squashed commits. -- If you continue working on the head branch of a pull request after squashing and merging, and then create a new pull request between the same branches, commits that you previously squashed and merged will be listed in the new pull request. You may also have conflicts that you have to repeatedly resolve in each successive pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squashing-and-merging-a-long-running-branch)." -- Some Git commands that use the "SHA" or "hash" ID may be harder to use since the SHA ID for the original commits is lost. For example, using [`git rerere`](https://git-scm.com/docs/git-rerere) may not be as effective. +* You lose information about when specific changes were originally made and who authored the squashed commits. +* If you continue working on the head branch of a pull request after squashing and merging, and then create a new pull request between the same branches, commits that you previously squashed and merged will be listed in the new pull request. You may also have conflicts that you have to repeatedly resolve in each successive pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squashing-and-merging-a-long-running-branch)." +* Some Git commands that use the "SHA" or "hash" ID may be harder to use since the SHA ID for the original commits is lost. For example, using [`git rerere`](https://git-scm.com/docs/git-rerere) may not be as effective. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)." @@ -43,8 +43,8 @@ For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-me {% data reusables.pull_requests.rebase_and_merge_summary %} Before enabling commit rebasing, consider these disadvantages: -- Repository contributors may have to rebase on the command line, resolve any conflicts, and force push their changes to the pull request's topic branch (or remote head branch) before they can use the **rebase and merge** option on {% data variables.location.product_location %}. Force pushing must be done carefully so contributors don't overwrite work that others have based their work on. To learn more about when the **Rebase and merge** option is disabled on {% data variables.location.product_location %} and the workflow to re-enable it, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#rebase-and-merge-your-pull-request-commits)." -- {% indented_data_reference reusables.pull_requests.rebase_and_merge_verification spaces=2 %} +* Repository contributors may have to rebase on the command line, resolve any conflicts, and force push their changes to the pull request's topic branch (or remote head branch) before they can use the **rebase and merge** option on {% data variables.location.product_location %}. Force pushing must be done carefully so contributors don't overwrite work that others have based their work on. To learn more about when the **Rebase and merge** option is disabled on {% data variables.location.product_location %} and the workflow to re-enable it, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#rebase-and-merge-your-pull-request-commits)." +* {% indented_data_reference reusables.pull_requests.rebase_and_merge_verification spaces=2 %} {% indented_data_reference reusables.pull_requests.rebase_and_merge_verification_2 spaces=2 %} diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md index 7e7cc998817d..e56255ffece8 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md @@ -24,5 +24,5 @@ If you select more than one merge method, collaborators can choose which type of ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)" diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md index b25e52e55fa4..43332354be57 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md @@ -31,5 +31,5 @@ If you select more than one merge method, collaborators can choose which type of ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)" diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md index c9638175c345..4153aef96437 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md @@ -25,9 +25,9 @@ For more information on merging a pull request using a merge queue, see "[AUTOTI **Notes:** -- A merge queue cannot be enabled with branch protection rules that use wildcard characters (`*`) in the branch name pattern. -- A merge queue will wait for required checks to be reported before it can proceed with merging. You must update your CI configuration to trigger and report on merge group events when requiring a merge queue. -- Merge queue and pull requests checks are coupled and configured under branch protection rules or rulesets. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#managing-a-merge-queue)." +* A merge queue cannot be enabled with branch protection rules that use wildcard characters (`*`) in the branch name pattern. +* A merge queue will wait for required checks to be reported before it can proceed with merging. You must update your CI configuration to trigger and report on merge group events when requiring a merge queue. +* Merge queue and pull requests checks are coupled and configured under branch protection rules or rulesets. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#managing-a-merge-queue)." {% endnote %} @@ -61,9 +61,9 @@ Repository administrators can require a merge queue by enabling the branch prote Once you have enabled the "Require merge queue" setting, you can also access the following settings: -- **Merge method**: Select which method to use when merging queued pull requests: merge, rebase, or squash. +* **Merge method**: Select which method to use when merging queued pull requests: merge, rebase, or squash. -- **Build concurrency**: The maximum number of `merge_group` webhooks to dispatch (between `1` and `100`), throttling the total amount of concurrent CI builds. This affects the velocity of merges that a merge queue can complete. +* **Build concurrency**: The maximum number of `merge_group` webhooks to dispatch (between `1` and `100`), throttling the total amount of concurrent CI builds. This affects the velocity of merges that a merge queue can complete. - **Only merge non-failing pull requests**: This setting determines how a merge queue forms groups of pull requests to be merged. @@ -72,7 +72,7 @@ Once you have enabled the "Require merge queue" setting, you can also access the | Yes | All pull requests must satisfy required checks to be merged. | | No | Pull requests that have failed required checks can be added to a group as long as the last pull request in the group has passed required checks. If the last pull request in the group has passed required checks, this means that the checks have passed for the combined set of changes in the merge group. Leaving this checkbox unselected can be useful if you have intermittent test failures, but don't want false negatives to hold up the queue. | -- **Status check timeout**: Choose how long the queue should wait for a response from CI before assuming that checks have failed. +* **Status check timeout**: Choose how long the queue should wait for a response from CI before assuming that checks have failed. - **Merge limits**: Select the minimum and maximum number of pull requests to merge into the base branch at the same time (between `1` and `100`), and a timeout after which the queue should stop waiting for more entries and merge with fewer than the minimum number. @@ -145,5 +145,5 @@ The following scenario outlines what happens when a user jumps the queue. ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue)" -- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue)" +* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)" diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md index dc1553b79bae..27944f691777 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md @@ -21,5 +21,5 @@ Anyone with admin permissions to a repository can enable or disable the automati ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)" diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md index 4062cf691c76..4c9e267482c6 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md @@ -40,5 +40,5 @@ You can restore the head branch of a closed pull request. ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)" -- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)" +* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches)" diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md index 081a25102879..5a71c6e1efbf 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md @@ -16,16 +16,16 @@ shortTitle: View branches {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-branches %} 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 branches (excluding the default branch) that anyone has committed to within the last three months, ordered by the branches with the most recent commits first. - - **Stale branches**: The **Stale** view shows all branches that no one has committed to in the last three months, ordered by the branches with the oldest commits first. Use this list to determine [which branches to delete](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository). - - **All branches**: The **All** view shows the default branch, followed by all other branches ordered by the branches with the most recent commits first. + * **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 branches (excluding the default branch) that anyone has committed to within the last three months, ordered by the branches with the most recent commits first. + * **Stale branches**: The **Stale** view shows all branches that no one has committed to in the last three months, ordered by the branches with the oldest commits first. Use this list to determine [which branches to delete](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository). + * **All branches**: The **All** view shows the default branch, followed by all other branches ordered by the branches with the most recent commits first. 1. Optionally, use the search field on the top right. It provides a simple, case-insensitive, sub-string search on the branch name. It does not support any additional query syntax. ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)" -- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)" +* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request)" {%- ifversion repository-activity-view %} -- "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository)."{% endif %} +* "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository)."{% endif %} diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md index 69ecbedf9e6e..d090e9e3a834 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md @@ -51,24 +51,24 @@ By default, the restrictions of a branch protection rule don't apply to people w ## About branch protection settings For each branch protection rule, you can choose to enable or disable the following settings. -- [Require pull request reviews before merging](#require-pull-request-reviews-before-merging) -- [Require status checks before merging](#require-status-checks-before-merging) -- [Require conversation resolution before merging](#require-conversation-resolution-before-merging) -- [Require signed commits](#require-signed-commits) -- [Require linear history](#require-linear-history) +* [Require pull request reviews before merging](#require-pull-request-reviews-before-merging) +* [Require status checks before merging](#require-status-checks-before-merging) +* [Require conversation resolution before merging](#require-conversation-resolution-before-merging) +* [Require signed commits](#require-signed-commits) +* [Require linear history](#require-linear-history) {% ifversion merge-queue %} -- [Require merge queue](#require-merge-queue) +* [Require merge queue](#require-merge-queue) {% endif %} {%- ifversion required-deployments %} -- [Require deployments to succeed before merging](#require-deployments-to-succeed-before-merging) +* [Require deployments to succeed before merging](#require-deployments-to-succeed-before-merging) {%- endif %} {%- ifversion lock-branch %} -- [Lock branch](#lock-branch) +* [Lock branch](#lock-branch) {%- endif %} {% ifversion bypass-branch-protections %}- [Do not allow bypassing the above settings](#do-not-allow-bypassing-the-above-settings){% else %}- [Include administrators](#include-administrators){% endif %} -- [Restrict who can push to matching branches](#restrict-who-can-push-to-matching-branches) -- [Allow force pushes](#allow-force-pushes) -- [Allow deletions](#allow-deletions) +* [Restrict who can push to matching branches](#restrict-who-can-push-to-matching-branches) +* [Allow force pushes](#allow-force-pushes) +* [Allow deletions](#allow-deletions) For more information on how to set up branch protection, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule)." @@ -138,8 +138,8 @@ When you enable required commit signing on a branch, contributors {% ifversion f {% ifversion fpt or ghec %} **Notes:** -- If you have enabled vigilant mode, which indicates that your commits will always be signed, any commits that {% data variables.product.prodname_dotcom %} identifies as "Partially verified" are permitted on branches that require signed commits. For more information about vigilant mode, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits)." -- If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. +* If you have enabled vigilant mode, which indicates that your commits will always be signed, any commits that {% data variables.product.prodname_dotcom %} identifies as "Partially verified" are permitted on branches that require signed commits. For more information about vigilant mode, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits)." +* If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. {% else %} **Note:** If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule.md index 36c4934fbf7a..3b50bf9f3934 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule.md @@ -68,21 +68,21 @@ When you create a branch rule, the branch you specify doesn't have to exist yet {% ifversion pull-request-mergeability-security-changes %} {% indented_data_reference reusables.pull_requests.security-changes-mergeability spaces=3 %} {% endif %} - - Under "Protect matching branches", select **Require a pull request before merging**. - - Optionally, to require approvals before a pull request can be merged, select **Require approvals**. + * Under "Protect matching branches", select **Require a pull request before merging**. + * Optionally, to require approvals before a pull request can be merged, select **Require approvals**. Select the **Required number of approvals before merging** dropdown menu, then click the number of approving reviews you would like to require on the branch. - - Optionally, to dismiss a pull request approval review when a code-modifying commit is pushed to the branch, select **Dismiss stale pull request approvals when new commits are pushed**. - - Optionally, to require review from a code owner when the pull request affects code that has a designated owner, select **Require review from Code Owners**. Note that if code has multiple owners, an approval from _any_ of the code owners will be sufficient to meet this requirement. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." - - Optionally, to allow specific actors to push code to the branch without creating pull requests when they're required, select **Allow specified actors to bypass required pull requests**. Then, search for and select the actors who should be allowed to skip creating a pull request. - - Optionally, if the repository is part of an organization, select **Restrict who can dismiss pull request reviews**. Then, in the search field, search for and select the actors who are allowed to dismiss pull request reviews. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)." + * Optionally, to dismiss a pull request approval review when a code-modifying commit is pushed to the branch, select **Dismiss stale pull request approvals when new commits are pushed**. + * Optionally, to require review from a code owner when the pull request affects code that has a designated owner, select **Require review from Code Owners**. Note that if code has multiple owners, an approval from _any_ of the code owners will be sufficient to meet this requirement. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * Optionally, to allow specific actors to push code to the branch without creating pull requests when they're required, select **Allow specified actors to bypass required pull requests**. Then, search for and select the actors who should be allowed to skip creating a pull request. + * Optionally, if the repository is part of an organization, select **Restrict who can dismiss pull request reviews**. Then, in the search field, search for and select the actors who are allowed to dismiss pull request reviews. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)." {% ifversion last-pusher-require-approval %} - - Optionally, to require someone other than the last person to push to a branch to approve a pull request prior to merging, select **Require approval of the most recent reviewable push**. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-pull-request-reviews-before-merging)." + * Optionally, to require someone other than the last person to push to a branch to approve a pull request prior to merging, select **Require approval of the most recent reviewable push**. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-pull-request-reviews-before-merging)." {% endif %} 1. Optionally, enable required status checks. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." - - Select **Require status checks to pass before merging**. - - Optionally, to ensure that pull requests are tested with the latest code on the protected branch, select **Require branches to be up to date before merging**. - - In the search field, search for status checks, selecting the checks you want to require. + * Select **Require status checks to pass before merging**. + * Optionally, to ensure that pull requests are tested with the latest code on the protected branch, select **Require branches to be up to date before merging**. + * In the search field, search for status checks, selecting the checks you want to require. 1. Optionally, select **Require conversation resolution before merging**. 1. Optionally, select **Require signed commits**. 1. Optionally, select **Require linear history**. @@ -94,21 +94,21 @@ When you create a branch rule, the branch you specify doesn't have to exist yet {%- endif %} {% ifversion lock-branch %} 1. Optionally, make the branch read-only. - - Select **Lock branch**. - - Optionally, to allow fork syncing, select **Allow fork syncing**. + * Select **Lock branch**. + * Optionally, to allow fork syncing, select **Allow fork syncing**. {%- endif %} 1. Optionally, select {% ifversion bypass-branch-protections %}**Do not allow bypassing the above settings**{% else %}**Apply the rules above to administrators**{% endif %}. 1. Optionally,{% ifversion fpt or ghec %} in public repositories owned by a {% data variables.product.prodname_free_user %} organization and in all repositories owned by an organization using {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %},{% endif %} enable branch restrictions. - - Select **Restrict who can push to matching branches**. + * Select **Restrict who can push to matching branches**. {%- ifversion restrict-pushes-create-branch %} - - Optionally, to also restrict the creation of matching branches, select **Restrict pushes that create matching branches**. + * Optionally, to also restrict the creation of matching branches, select **Restrict pushes that create matching branches**. {%- endif %} - - In the search field, search for and select the people, teams, or apps who will have permission to push to the protected branch or create a matching branch. + * In the search field, search for and select the people, teams, or apps who will have permission to push to the protected branch or create a matching branch. 1. Optionally, under "Rules applied to everyone including administrators", select **Allow force pushes**. Then, choose who can force push to the branch. - - Select **Everyone** to allow everyone with at least write permissions to the repository to force push to the branch, including those with admin permissions. - - Select **Specify who can force push** to allow only specific actors to force push to the branch. Then, search for and select those actors. + * Select **Everyone** to allow everyone with at least write permissions to the repository to force push to the branch, including those with admin permissions. + * Select **Specify who can force push** to allow only specific actors to force push to the branch. Then, search for and select those actors. For more information about force pushes, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#allow-force-pushes)." 1. Optionally, select **Allow deletions**. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets.md index cced96cedf23..c373bc8591bd 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets.md @@ -60,10 +60,10 @@ Rulesets work alongside any branch protection rules and tag protection rules in Rulesets have the following advantages over branch and tag protection rules. -- Unlike protection rules, multiple rulesets can apply at the same time, so you can be confident that every rule targeting a branch or tag in your repository will be evaluated when someone interacts with that branch or tag. For more information, see "[About rule layering](#about-rule-layering)." -- Rulesets have statuses, so you can easily manage which rulesets are active in a repository without needing to delete rulesets. -- Anyone with read access to a repository can view the active rulesets for the repository. This means a developer can understand why they have hit a rule, or an auditor can check the security constraints for the repository, without requiring admin access to the repository. -- You can create additional rules to control the metadata of commits entering a repository, such as the commit message and the author's email address. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#metadata-restrictions){% ifversion ghec %}."{% else %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} +* Unlike protection rules, multiple rulesets can apply at the same time, so you can be confident that every rule targeting a branch or tag in your repository will be evaluated when someone interacts with that branch or tag. For more information, see "[About rule layering](#about-rule-layering)." +* Rulesets have statuses, so you can easily manage which rulesets are active in a repository without needing to delete rulesets. +* Anyone with read access to a repository can view the active rulesets for the repository. This means a developer can understand why they have hit a rule, or an auditor can check the security constraints for the repository, without requiring admin access to the repository. +* You can create additional rules to control the metadata of commits entering a repository, such as the commit message and the author's email address. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#metadata-restrictions){% ifversion ghec %}."{% else %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} ## Using ruleset enforcement statuses @@ -75,8 +75,8 @@ A ruleset does not have a priority. Instead, if multiple rulesets target the sam For example, consider the following situation for the `my-feature` branch of the `octo-org/octo-repo` repository. -- An administrator of the repository has set up a ruleset targeting the `my-feature` branch. This ruleset requires signed commits, and three reviews on pull requests before they can be merged. -- An existing branch protection rule for the `my-feature` branch requires a linear commit history, and two reviews on pull requests before they can be merged.{% ifversion repo-rules-enterprise %} -- An administrator of the `octo-org` organization has also set up a ruleset targeting the `my-feature` branch of the `octo-repo` repository. The ruleset blocks force pushes, and requires one review on pull requests before they can be merged.{% endif %} +* An administrator of the repository has set up a ruleset targeting the `my-feature` branch. This ruleset requires signed commits, and three reviews on pull requests before they can be merged. +* An existing branch protection rule for the `my-feature` branch requires a linear commit history, and two reviews on pull requests before they can be merged.{% ifversion repo-rules-enterprise %} +* An administrator of the `octo-org` organization has also set up a ruleset targeting the `my-feature` branch of the `octo-repo` repository. The ruleset blocks force pushes, and requires one review on pull requests before they can be merged.{% endif %} The rules from each source are aggregated, and all rules apply. Where multiple different versions of the same rule exist, the result is that the most restrictive version of the rule applies. Therefore, the `my-feature` branch requires signed commits and a linear commit history{% ifversion repo-rules-enterprise %}, force pushes are blocked{% endif %}, and pull requests targeting the branch will require three reviews before they can be merged. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md index 698e923f7ee0..51501ade7441 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md @@ -45,8 +45,8 @@ Before you can require a linear commit history, your repository must allow squas ## Require merge queue > [!NOTE] -> - Configuring a merge queue via rulesets is in public beta and subject to change. -> - This rule is not available for rulesets created at the organization level. For more information about creating rulesets at the repository level, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository)." +> * Configuring a merge queue via rulesets is in public beta and subject to change. +> * This rule is not available for rulesets created at the organization level. For more information about creating rulesets at the repository level, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository)." You can require that merges must be performed with a merge queue at the repository level. For more information about merge queues, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue#about-merge-queues)." @@ -54,16 +54,16 @@ You can require that merges must be performed with a merge queue at the reposito You can configure various settings for your merge queue rule. -- **Merge method**: Method to use when merging changes from pull requests. -- **Build concurrency**: Limit the number of queued pull requests requesting checks and workflow runs at the same time. - - This setting controls when merge queue dispatches the `merge_group.checks_requested` webhook event, which triggers {% data variables.product.prodname_actions %} workflows that are configured to run on `merge_group`. For more information, see "[AUTOTITLE](/webhooks/webhook-events-and-payloads#merge_group)." - - For example, if there are 5 pull requests added to the queue and the build concurrency setting is 3, merge queue will dispatch the `checks_requested` event for the first 3 pull requeusts. When it receives a result for one of those pull requests, merge queue will dispatch the event for the 4th pull request, and so on. -- **Minimum/maximum group size**: The number of pull requests that will be merged together in a group. -- **Wait time to meet minimum group size (minutes)**: The time the merge queue will wait after the first pull request is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. -- **Require all queue entries to pass required checks**: - - When this setting is enabled, each item in the merge group must pass all required checks. - - When this setting is disabled, only the commit at the head of the merge group, i.e. the commit containing changes from all of the pull requests in the group, must pass its required checks to merge. -- **Status check timeout (minutes)**: Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed +* **Merge method**: Method to use when merging changes from pull requests. +* **Build concurrency**: Limit the number of queued pull requests requesting checks and workflow runs at the same time. + * This setting controls when merge queue dispatches the `merge_group.checks_requested` webhook event, which triggers {% data variables.product.prodname_actions %} workflows that are configured to run on `merge_group`. For more information, see "[AUTOTITLE](/webhooks/webhook-events-and-payloads#merge_group)." + * For example, if there are 5 pull requests added to the queue and the build concurrency setting is 3, merge queue will dispatch the `checks_requested` event for the first 3 pull requeusts. When it receives a result for one of those pull requests, merge queue will dispatch the event for the 4th pull request, and so on. +* **Minimum/maximum group size**: The number of pull requests that will be merged together in a group. +* **Wait time to meet minimum group size (minutes)**: The time the merge queue will wait after the first pull request is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. +* **Require all queue entries to pass required checks**: + * When this setting is enabled, each item in the merge group must pass all required checks. + * When this setting is disabled, only the commit at the head of the merge group, i.e. the commit containing changes from all of the pull requests in the group, must pass its required checks to merge. +* **Status check timeout (minutes)**: Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed {% endif %} @@ -88,8 +88,8 @@ With both methods, we use the `verified_signature?` to confirm if a commit has a {% ifversion fpt or ghec %} > [!NOTE] -> - If you have enabled vigilant mode in your account settings, which indicates that your commits will always be signed, any commits that {% data variables.product.prodname_dotcom %} identifies as "Partially verified" are permitted on branches that require signed commits. For more information about vigilant mode, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits)." -> - If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. +> * If you have enabled vigilant mode in your account settings, which indicates that your commits will always be signed, any commits that {% data variables.product.prodname_dotcom %} identifies as "Partially verified" are permitted on branches that require signed commits. For more information about vigilant mode, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits)." +> * If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. {% else %} diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/troubleshooting-rules.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/troubleshooting-rules.md index 87cd2f74d129..ff115be57a22 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/troubleshooting-rules.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/troubleshooting-rules.md @@ -50,9 +50,9 @@ Verify that your ruleset workflow does not target all branches in the repository ### Supported directory Verify that your workflow file exists in the `.github/workflows` directory. If you want to run a ruleset workflow on `pull_request` events in a repository that is not the source repository, you can take any of the following actions: - - Add a conditional to the workflow file such as, `if: {{ github.repository != 'my-org/source-repo' }}`. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idif)." - - Disable Actions completely in the source repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository). - - Disable the individual workflow in the source repository. For more information, see "[AUTOTITLE](/actions/using-workflows/disabling-and-enabling-a-workflow). + * Add a conditional to the workflow file such as, `if: {{ github.repository != 'my-org/source-repo' }}`. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idif)." + * Disable Actions completely in the source repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository). + * Disable the individual workflow in the source repository. For more information, see "[AUTOTITLE](/actions/using-workflows/disabling-and-enabling-a-workflow). ### Using the `merge_group` trigger diff --git a/content/repositories/creating-and-managing-repositories/about-repositories.md b/content/repositories/creating-and-managing-repositories/about-repositories.md index 440415f9463d..945b589026ad 100644 --- a/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -52,10 +52,10 @@ In either case, access to repositories is managed by permissions. For more infor ## About collaboration You can use repositories to manage your work and collaborate with others. -- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues)."{% ifversion fpt or ghec %} -- {% data reusables.discussions.you-can-use-discussions %}{% endif %} -- You can use pull requests to propose changes to a repository. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." -- You can use {% data variables.product.prodname_projects_v2 %} to organize and prioritize your issues and pull requests. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." +* You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues)."{% ifversion fpt or ghec %} +* {% data reusables.discussions.you-can-use-discussions %}{% endif %} +* You can use pull requests to propose changes to a repository. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." +* You can use {% data variables.product.prodname_projects_v2 %} to organize and prioritize your issues and pull requests. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." {% ifversion fpt or ghec %} With {% data variables.product.prodname_free_team %} for personal accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} @@ -70,14 +70,14 @@ You can restrict who has access to a repository by choosing a repository's visib When you create a repository, you can choose to make the repository public or private.{% ifversion ghec or ghes %} If you're creating the repository in an organization{% ifversion ghec %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% ifversion fpt %} Repositories in organizations that use {% data variables.product.prodname_ghe_cloud %} and are owned by an enterprise account can also be created with internal visibility. For more information, see [the {% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).{% endif %} {%- ifversion fpt or ghec %} -- {% ifversion ghec %}If your account is not a {% data variables.enterprise.prodname_managed_user %}, you can create public repositories. {% endif %}Public repositories are accessible to everyone on the internet. -- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. +* {% ifversion ghec %}If your account is not a {% data variables.enterprise.prodname_managed_user %}, you can create public repositories. {% endif %}Public repositories are accessible to everyone on the internet. +* Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. {%- elsif ghes %} -- If {% data variables.location.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.location.product_location %}, including outside collaborators. -- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. +* If {% data variables.location.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.location.product_location %}, including outside collaborators. +* Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. {%- endif %} {%- ifversion ghec or ghes %} -- Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." +* Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)." {%- endif %} Organization owners always have access to every repository created in an organization. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)." @@ -118,7 +118,7 @@ By default, enterprise members can fork an internal repository into any organiza Here are some helpful resources for taking your next steps with repositories. -- "[AUTOTITLE](/repositories/creating-and-managing-repositories/best-practices-for-repositories):" Learn how to use repositories most effectively. -- "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository):" Create a new repository. -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository):" Learn how to create and delete branches within your repository. -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request):" Create a pull request to propose and collaborate on changes to a repository. +* "[AUTOTITLE](/repositories/creating-and-managing-repositories/best-practices-for-repositories):" Learn how to use repositories most effectively. +* "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository):" Create a new repository. +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository):" Learn how to create and delete branches within your repository. +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request):" Create a pull request to propose and collaborate on changes to a repository. diff --git a/content/repositories/creating-and-managing-repositories/cloning-a-repository.md b/content/repositories/creating-and-managing-repositories/cloning-a-repository.md index 5c1ee6f4e548..d0ad913e2ff3 100644 --- a/content/repositories/creating-and-managing-repositories/cloning-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/cloning-a-repository.md @@ -102,13 +102,13 @@ When cloning a repository it's possible that you might encounter some errors. If you're unable to clone a repository, check that: -- You can connect using HTTPS. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors)." -- You have permission to access the repository you want to clone. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors)." -- The default branch you want to clone still exists. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors#error-remote-head-refers-to-nonexistent-ref-unable-to-checkout)." +* You can connect using HTTPS. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors)." +* You have permission to access the repository you want to clone. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors)." +* The default branch you want to clone still exists. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors#error-remote-head-refers-to-nonexistent-ref-unable-to-checkout)." {% ifversion fpt or ghec %} ## Further reading -- "[AUTOTITLE](/get-started/using-github/troubleshooting-connectivity-problems)" +* "[AUTOTITLE](/get-started/using-github/troubleshooting-connectivity-problems)" {% endif %} diff --git a/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md b/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md index 726e8edcdd05..6766606f921a 100644 --- a/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md @@ -43,9 +43,9 @@ topics: {% data reusables.repositories.repo-name %} {% data reusables.repositories.choose-repo-visibility %} 1. If you're not using a template, there are a number of optional items you can pre-populate your repository with. If you're importing an existing repository to {% data variables.product.product_name %}, don't choose any of these options, as you may introduce a merge conflict. You can add or create new files using the user interface or choose to add new files using the command line later. For more information, see "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)," "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line)," and "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)." - - You can create a README, which is a document describing your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)." - - You can create a _.gitignore_ file, which is a set of ignore rules. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/ignoring-files)."{% ifversion fpt or ghec %} - - You can choose to add a software license for your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."{% endif %} + * You can create a README, which is a document describing your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)." + * You can create a _.gitignore_ file, which is a set of ignore rules. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/ignoring-files)."{% ifversion fpt or ghec %} + * You can choose to add a software license for your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."{% endif %} {% data reusables.repositories.select-marketplace-apps %} {% data reusables.repositories.create-repo %} {% ifversion fpt or ghec %} @@ -75,6 +75,6 @@ Query parameter | Example | Valid values ## Further reading -- "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories)" -- [Open Source Guides](https://opensource.guide/){% ifversion fpt or ghec %} -- [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %} +* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories)" +* [Open Source Guides](https://opensource.guide/){% ifversion fpt or ghec %} +* [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %} diff --git a/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md b/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md index 0d08dd3c8eda..fa312f7f064d 100644 --- a/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md @@ -27,9 +27,9 @@ shortTitle: Create from a template You can choose to include the directory structure and files from only the default branch of the template repository or to include all branches. Branches created from a template have unrelated histories, which means you cannot create pull requests or merge between the branches. Creating a repository from a template is similar to forking a repository, but there are important differences: -- A new fork includes the entire commit history of the parent repository, while a repository created from a template starts with a single commit. -- Commits to a fork don't appear in your contributions graph, while commits to a repository created from a template do appear in your contribution graph. -- A fork can be a temporary way to contribute code to an existing project, while creating a repository from a template starts a new project quickly. +* A new fork includes the entire commit history of the parent repository, while a repository created from a template starts with a single commit. +* Commits to a fork don't appear in your contributions graph, while commits to a repository created from a template do appear in your contribution graph. +* A fork can be a temporary way to contribute code to an existing project, while creating a repository from a template starts a new project quickly. For more information about forks, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)." diff --git a/content/repositories/creating-and-managing-repositories/deleting-a-repository.md b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md index 34bfbbf9d512..e9bfcc465b50 100644 --- a/content/repositories/creating-and-managing-repositories/deleting-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md @@ -22,8 +22,8 @@ Deleting a public repository will not delete any forks of the repository. **Warnings**: -- Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone. -- Deleting a private{% ifversion ghes or ghec %} or internal{% endif %} repository will delete all forks of the repository. +* Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone. +* Deleting a private{% ifversion ghes or ghec %} or internal{% endif %} repository will delete all forks of the repository. {% endwarning %} diff --git a/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md b/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md index 7a39164ea146..cc77c335dad4 100644 --- a/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md @@ -119,7 +119,7 @@ If you want to mirror a repository in another location, including getting update ## Further reading -- "[AUTOTITLE](/desktop/making-changes-in-a-branch/pushing-changes-to-github-from-github-desktop#pushing-changes-to-github)" -- "[AUTOTITLE](/desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop)" +* "[AUTOTITLE](/desktop/making-changes-in-a-branch/pushing-changes-to-github-from-github-desktop#pushing-changes-to-github)" +* "[AUTOTITLE](/desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop)" {% endif %} diff --git a/content/repositories/creating-and-managing-repositories/quickstart-for-repositories.md b/content/repositories/creating-and-managing-repositories/quickstart-for-repositories.md index e585e66981ff..a1b930c8ace2 100644 --- a/content/repositories/creating-and-managing-repositories/quickstart-for-repositories.md +++ b/content/repositories/creating-and-managing-repositories/quickstart-for-repositories.md @@ -118,12 +118,12 @@ You have now created a repository, including a _README_ file, and created your f {% webui %} -- You can now clone a {% data variables.product.prodname_dotcom %} repository to create a local copy on your computer. From your local repository you can commit, and create a pull request to update the changes in the upstream repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository)" and "[AUTOTITLE](/get-started/getting-started-with-git/set-up-git)." +* You can now clone a {% data variables.product.prodname_dotcom %} repository to create a local copy on your computer. From your local repository you can commit, and create a pull request to update the changes in the upstream repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository)" and "[AUTOTITLE](/get-started/getting-started-with-git/set-up-git)." {% endwebui %} -- You can find interesting projects and repositories on {% data variables.product.prodname_dotcom %} and make changes to them by creating a fork of the repository. {% data reusables.getting-started.fork-a-repository %} +* You can find interesting projects and repositories on {% data variables.product.prodname_dotcom %} and make changes to them by creating a fork of the repository. {% data reusables.getting-started.fork-a-repository %} -- {% data reusables.getting-started.being-social %} +* {% data reusables.getting-started.being-social %} -- {% data reusables.support.connect-in-the-forum-bootcamp %} +* {% data reusables.support.connect-in-the-forum-bootcamp %} diff --git a/content/repositories/creating-and-managing-repositories/renaming-a-repository.md b/content/repositories/creating-and-managing-repositories/renaming-a-repository.md index 6dc1cd8c7b00..cdae6e8d55fb 100644 --- a/content/repositories/creating-and-managing-repositories/renaming-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/renaming-a-repository.md @@ -14,10 +14,10 @@ topics: --- 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 +* Issues +* Wikis +* Stars +* Followers For more information on project sites, see "[AUTOTITLE](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)." diff --git a/content/repositories/creating-and-managing-repositories/repository-limits.md b/content/repositories/creating-and-managing-repositories/repository-limits.md index ba3473ac94f3..595ef2f161d4 100644 --- a/content/repositories/creating-and-managing-repositories/repository-limits.md +++ b/content/repositories/creating-and-managing-repositories/repository-limits.md @@ -21,10 +21,10 @@ Most of the limits below affect both {% data variables.product.product_name %} a Because diffs can become very large, we impose these limits on diffs for commits, pull requests, and compare views: -- In a pull request, no total diff may exceed _20,000 lines that you can load_ or _1 MB_ of raw diff data. -- No single file's diff may exceed _20,000 lines that you can load_ or _500 KB_ of raw diff data. _Four hundred lines_ and _20 KB_ are automatically loaded for a single file. -- The maximum number of files in a single diff is limited to _300_. -- The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to _25_. +* In a pull request, no total diff may exceed _20,000 lines that you can load_ or _1 MB_ of raw diff data. +* No single file's diff may exceed _20,000 lines that you can load_ or _500 KB_ of raw diff data. _Four hundred lines_ and _20 KB_ are automatically loaded for a single file. +* The maximum number of files in a single diff is limited to _300_. +* The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to _25_. Some portions of a limited diff may be displayed, but anything exceeding the limit is not shown. diff --git a/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md index cf0ed9e2db40..d4483887303a 100644 --- a/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md +++ b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md @@ -56,6 +56,6 @@ Restoring a repository will not restore release attachments or team permissions. ## Further reading -- "[AUTOTITLE](/repositories/creating-and-managing-repositories/deleting-a-repository)" +* "[AUTOTITLE](/repositories/creating-and-managing-repositories/deleting-a-repository)" {% endif %} diff --git a/content/repositories/creating-and-managing-repositories/transferring-a-repository.md b/content/repositories/creating-and-managing-repositories/transferring-a-repository.md index 4acbb4e1bca6..e08514bb380b 100644 --- a/content/repositories/creating-and-managing-repositories/transferring-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/transferring-a-repository.md @@ -26,13 +26,13 @@ topics: When you transfer a repository to a new owner, they can immediately administer the repository's contents, issues, pull requests, releases, {% data variables.product.prodname_projects_v1 %}, and settings. {% ifversion rename-and-transfer-repository %}You can also change the repository name while transferring a repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/renaming-a-repository)."{% endif %} Prerequisites for repository transfers: -- When you transfer a repository that you own to another personal account, the new owner will receive a confirmation email.{% ifversion fpt or ghec %} The confirmation email includes instructions for accepting the transfer. If the new owner doesn't accept the transfer within one day, the invitation will expire.{% endif %} -- To transfer a repository that you own to an organization, you must have permission to create a repository in the target organization. -- The target account must not have a repository with the same name, or a fork in the same network. -- The original owner of the repository is added as a collaborator on the transferred repository. Other collaborators to the transferred repository remain intact. -- Single repositories forked from a private upstream network cannot be transferred. +* When you transfer a repository that you own to another personal account, the new owner will receive a confirmation email.{% ifversion fpt or ghec %} The confirmation email includes instructions for accepting the transfer. If the new owner doesn't accept the transfer within one day, the invitation will expire.{% endif %} +* To transfer a repository that you own to an organization, you must have permission to create a repository in the target organization. +* The target account must not have a repository with the same name, or a fork in the same network. +* The original owner of the repository is added as a collaborator on the transferred repository. Other collaborators to the transferred repository remain intact. +* Single repositories forked from a private upstream network cannot be transferred. {%- ifversion ghec %} -- Internal repositories can only be transferred to an organization in the enterprise. You cannot transfer an internal repository from an organization owned by one enterprise account to an organization owned by a different enterprise account. +* Internal repositories can only be transferred to an organization in the enterprise. You cannot transfer an internal repository from an organization owned by one enterprise account to an organization owned by a different enterprise account. {%- endif %} {% ifversion fpt or ghec %}If you transfer a private repository to a {% data variables.product.prodname_free_user %} user or organization account, the repository will lose access to features like protected branches and {% data variables.product.prodname_pages %}. {% data reusables.gated-features.more-info %} @@ -43,12 +43,12 @@ If the transferred repository contains an action listed on {% data variables.pro When you transfer a repository, its issues, pull requests, wiki, stars, and watchers are also transferred. If the transferred repository contains webhooks, services, secrets, or deploy keys, they will remain associated after the transfer is complete. Git information about commits, including contributions, is preserved. In addition: -- If the transferred repository is a fork, then it remains associated with the upstream repository. -- If the transferred repository has any forks, then those forks will remain associated with the repository after the transfer is complete. -- If the transferred repository uses {% data variables.large_files.product_name_long %}, all {% data variables.large_files.product_name_short %} objects are automatically moved. This transfer occurs in the background, so if you have a large number of {% data variables.large_files.product_name_short %} objects or if the {% data variables.large_files.product_name_short %} objects themselves are large, it may take some time for the transfer to occur.{% ifversion fpt or ghec %} Before you transfer a repository that uses {% data variables.large_files.product_name_short %}, make sure the receiving account has enough data packs to store the {% data variables.large_files.product_name_short %} objects you'll be moving over. For more information on adding storage for personal accounts, see "[AUTOTITLE](/billing/managing-billing-for-git-large-file-storage/upgrading-git-large-file-storage)."{% endif %} -- When a repository is transferred between two personal accounts, issue assignments are left intact. When you transfer a repository from a personal account to an organization, issues assigned to members in the organization remain intact, and all other issue assignees are cleared. Only owners in the organization are allowed to create new issue assignments. When you transfer a repository from an organization to a personal account, only issues assigned to the repository's owner are kept, and all other issue assignees are removed. -- If the transferred repository contains a {% data variables.product.prodname_pages %} site, then links to the Git repository on the Web and through Git activity are redirected. However, we don't redirect {% data variables.product.prodname_pages %} associated with the repository. -- All links to the previous repository location are automatically redirected to the new location. When you use `git clone`, `git fetch`, or `git push` on a transferred repository, these commands will redirect to the new repository location or URL. However, to avoid confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using `git remote` on the command line: +* If the transferred repository is a fork, then it remains associated with the upstream repository. +* If the transferred repository has any forks, then those forks will remain associated with the repository after the transfer is complete. +* If the transferred repository uses {% data variables.large_files.product_name_long %}, all {% data variables.large_files.product_name_short %} objects are automatically moved. This transfer occurs in the background, so if you have a large number of {% data variables.large_files.product_name_short %} objects or if the {% data variables.large_files.product_name_short %} objects themselves are large, it may take some time for the transfer to occur.{% ifversion fpt or ghec %} Before you transfer a repository that uses {% data variables.large_files.product_name_short %}, make sure the receiving account has enough data packs to store the {% data variables.large_files.product_name_short %} objects you'll be moving over. For more information on adding storage for personal accounts, see "[AUTOTITLE](/billing/managing-billing-for-git-large-file-storage/upgrading-git-large-file-storage)."{% endif %} +* When a repository is transferred between two personal accounts, issue assignments are left intact. When you transfer a repository from a personal account to an organization, issues assigned to members in the organization remain intact, and all other issue assignees are cleared. Only owners in the organization are allowed to create new issue assignments. When you transfer a repository from an organization to a personal account, only issues assigned to the repository's owner are kept, and all other issue assignees are removed. +* If the transferred repository contains a {% data variables.product.prodname_pages %} site, then links to the Git repository on the Web and through Git activity are redirected. However, we don't redirect {% data variables.product.prodname_pages %} associated with the repository. +* All links to the previous repository location are automatically redirected to the new location. When you use `git clone`, `git fetch`, or `git push` on a transferred repository, these commands will redirect to the new repository location or URL. However, to avoid confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using `git remote` on the command line: ```shell git remote set-url origin NEW_URL @@ -59,9 +59,9 @@ When you transfer a repository, its issues, pull requests, wiki, stars, and watc **Warning**: If you create a new repository or fork at the previous repository location, the redirects to the transferred repository will be deactivated. They can be reactivated by renaming or deleting the new repository or fork. {% endwarning %} -- When you transfer a repository from an organization to a personal account, the repository's read-only collaborators will not be transferred. This is because collaborators can't have read-only access to repositories owned by a personal account. For more information about repository permission levels, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository)" and "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)."{% ifversion fpt or ghec %} -- Sponsors who have access to the repository through a sponsorship tier may be affected. For more information, see "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers#adding-a-repository-to-a-sponsorship-tier)".{% endif %} -- Packages associated with the repository {% ifversion packages-registries-v2 %}may be transferred, or may lose their link to the repository, depending on the registry they belong to{% else %}are transferred as part of the transfer process{% endif %}. For more information, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#about-repository-transfers)." +* When you transfer a repository from an organization to a personal account, the repository's read-only collaborators will not be transferred. This is because collaborators can't have read-only access to repositories owned by a personal account. For more information about repository permission levels, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository)" and "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)."{% ifversion fpt or ghec %} +* Sponsors who have access to the repository through a sponsorship tier may be affected. For more information, see "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers#adding-a-repository-to-a-sponsorship-tier)".{% endif %} +* Packages associated with the repository {% ifversion packages-registries-v2 %}may be transferred, or may lose their link to the repository, depending on the registry they belong to{% else %}are transferred as part of the transfer process{% endif %}. For more information, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#about-repository-transfers)." For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/managing-remote-repositories)." diff --git a/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md index 87e45ae46530..4d919f232ef6 100644 --- a/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md +++ b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md @@ -110,9 +110,9 @@ If you are trying to clone a private repository but do not have permission to vi Make sure that you have access to the repository in one of these ways: -- The owner of the repository -- A [collaborator](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository) on the repository -- A [member of a team](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team) that has access to the repository (if the repository belongs to an organization) +* The owner of the repository +* A [collaborator](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository) on the repository +* A [member of a team](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team) that has access to the repository (if the repository belongs to an organization) ### Check your SSH access diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index 9778c8c09634..17f06fde00fc 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -58,9 +58,9 @@ To reduce the size of your CODEOWNERS file, consider using wildcard patterns to {% warning %} **Warning:** There are some syntax rules for gitignore files that _do not work_ in CODEOWNERS files: -- Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment -- Using `!` to negate a pattern -- Using `[ ]` to define a character range +* Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment +* Using `!` to negate a pattern +* Using `[ ]` to define a character range {% endwarning %} @@ -174,8 +174,8 @@ To protect a repository fully against unauthorized changes, you also need to def ## Further reading -- "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)" -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)" -- "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-an-individuals-access-to-an-organization-repository)" -- "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-team-access-to-an-organization-repository)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review)" +* "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)" +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)" +* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-an-individuals-access-to-an-organization-repository)" +* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-team-access-to-an-organization-repository)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review)" diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md index 5ce37117bd71..51a67906024c 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md @@ -21,11 +21,11 @@ topics: For more information about providing guidelines for your project, see {% ifversion fpt or ghec %}"[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and {% endif %}"[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions)." 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 the project -- Where users can get help with your project -- Who maintains and contributes to the project +* What the project does +* Why the project is useful +* How users can get started with the project +* Where users can get help with your project +* Who maintains and contributes to the project If you put your README file in your repository's hidden `.github`, root, or `docs` directory, {% data variables.product.product_name %} will recognize and automatically surface your README to repository visitors. @@ -53,8 +53,8 @@ A README should contain only the necessary information for developers to get sta ## Further reading -- "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)" -- "[5 tips for making your {% data variables.product.company_short %} profile page accessible](https://github.blog/2023-10-26-5-tips-for-making-your-github-profile-page-accessible/)" in the {% data variables.product.company_short %} blog +* "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)" +* "[5 tips for making your {% data variables.product.company_short %} profile page accessible](https://github.blog/2023-10-26-5-tips-for-making-your-github-profile-page-accessible/)" in the {% data variables.product.company_short %} blog {%- ifversion fpt or ghec %} -- "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/adding-a-codespaces-badge)" +* "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/adding-a-codespaces-badge)" {%- endif %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md index 6330f4988ddd..bb651e0d9ba6 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md @@ -32,9 +32,9 @@ Repository admins can add any topics they'd like to a repository. Helpful topics You can search for repositories that are associated with a particular topic. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-for-repositories#search-by-topic)." You can also search for a list of topics on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-topics)." When creating a topic: -- use lowercase letters, numbers, and hyphens. -- use 50 characters or less. -- add no more than 20 topics. +* use lowercase letters, numbers, and hyphens. +* use 50 characters or less. +* add no more than 20 topics. ## Adding topics to your repository diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md index 4e1eebf90471..86bad53cb18e 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md @@ -28,8 +28,8 @@ Until you add an image, repository links expand to show basic information about {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} 1. Under "Social preview", click **Edit**. - - To add a new image, click **Upload an image...**. - - To remove an image, click **Remove image**. + * To add a new image, click **Upload an image...**. + * To remove an image, click **Remove image**. ![Screenshot of the "Social Preview" section. The "Edit" button is highlighted with an orange outline, and a dropdown displays the options for uploading or removing an image.](/assets/images/help/repository/social-preview.png) diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md index 4869254a6b34..bb22acff85b0 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md @@ -82,5 +82,5 @@ Anyone with admin permissions can enable a sponsor button in a repository. ## Further reading -- "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" -- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} +* "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" +* "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md index 08bd0ff25223..ce739aac7f1b 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md @@ -100,5 +100,5 @@ The goal of GitHub's open source licensing efforts is to provide a starting poin ## Further reading -- The Open Source Guides' section "[The Legal Side of Open Source](https://opensource.guide/legal/)"{% ifversion fpt or ghec %} -- [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %} +* The Open Source Guides' section "[The Legal Side of Open Source](https://opensource.guide/legal/)"{% ifversion fpt or ghec %} +* [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md index 750f0571d540..9d5a401621fd 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md @@ -21,5 +21,5 @@ You can also use organization discussions to facilitate conversations that span ## Further reading -- "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions)" -- "[AUTOTITLE](/discussions/managing-discussions-for-your-community)" +* "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions)" +* "[AUTOTITLE](/discussions/managing-discussions-for-your-community)" diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md index 2fe1cbadd792..74c4145f962b 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md @@ -131,9 +131,9 @@ You can use the steps below to configure whether {% ifversion internal-actions%} {% data reusables.repositories.settings-sidebar-actions-general %} 1. Under **Access**, choose one of the access settings: - - **Not accessible** - Workflows in other repositories cannot access this repository. - - **Accessible from repositories in the 'ORGANIZATION NAME' organization** - {% ifversion ghes or ghec %}Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same organization and their visibility is private or internal.{% endif %} - - **Accessible from repositories in the 'ENTERPRISE NAME' enterprise** - {% ifversion ghes or ghec %}Workflows in other repositories that are part of the 'ENTERPRISE NAME' enterprise can access the actions and reusable workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same enterprise and their visibility is private or internal.{% endif %} + * **Not accessible** - Workflows in other repositories cannot access this repository. + * **Accessible from repositories in the 'ORGANIZATION NAME' organization** - {% ifversion ghes or ghec %}Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same organization and their visibility is private or internal.{% endif %} + * **Accessible from repositories in the 'ENTERPRISE NAME' enterprise** - {% ifversion ghes or ghec %}Workflows in other repositories that are part of the 'ENTERPRISE NAME' enterprise can access the actions and reusable workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same enterprise and their visibility is private or internal.{% endif %} 1. Click **Save** to apply the settings. {% endif %} @@ -154,8 +154,8 @@ You can use the steps below to configure whether actions and reusable workflows {% data reusables.repositories.settings-sidebar-actions-general %} 1. Under **Access**, choose one of the access settings: - - **Not accessible** - Workflows in other repositories cannot access this repository. - - **Accessible from repositories owned by 'USER NAME' user** - Workflows in other repositories that are owned by the same user can access the actions and reusable workflows in this repository. Access is allowed only from private repositories. + * **Not accessible** - Workflows in other repositories cannot access this repository. + * **Accessible from repositories owned by 'USER NAME' user** - Workflows in other repositories that are owned by the same user can access the actions and reusable workflows in this repository. Access is allowed only from private repositories. 1. Click **Save** to apply the settings. {% endif %} @@ -169,8 +169,8 @@ You can use the steps below to configure whether actions and reusable workflows {% data reusables.repositories.settings-sidebar-actions-general %} 1. Under **Access**, choose one of the access settings: - - **Not accessible** - Workflows in other repositories cannot access this repository. - - **Accessible from repositories in the 'ORGANIZATION NAME' organization** - Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private repositories. + * **Not accessible** - Workflows in other repositories cannot access this repository. + * **Accessible from repositories in the 'ORGANIZATION NAME' organization** - Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private repositories. 1. Click **Save** to apply the settings. {% endif %} @@ -181,9 +181,9 @@ You can use the steps below to configure whether actions and reusable workflows 1. Under your repository name, click {% octicon "gear" aria-hidden="true" %} **Settings**. {% data reusables.repositories.settings-sidebar-actions-general %} 1. Under **Access**, choose one of the access settings: - - **Not accessible** - Workflows in other repositories cannot access this repository. - - **Accessible from repositories in the 'ORGANIZATION NAME' organization** - Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private repositories. - - **Accessible from repositories in the 'ENTERPRISE NAME' enterprise** - Workflows in other repositories that are part of the 'ENTERPRISE NAME' enterprise can access the actions and reusable workflows in this repository. Access is allowed only from private repositories. + * **Not accessible** - Workflows in other repositories cannot access this repository. + * **Accessible from repositories in the 'ORGANIZATION NAME' organization** - Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private repositories. + * **Accessible from repositories in the 'ENTERPRISE NAME' enterprise** - Workflows in other repositories that are part of the 'ENTERPRISE NAME' enterprise can access the actions and reusable workflows in this repository. Access is allowed only from private repositories. 1. Click **Save** to apply the settings. {% endif %} {% endif %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md index e7ad962ad092..d97e0eb70084 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md @@ -93,5 +93,5 @@ Organization owners and repository administrators can only grant access to view ## Further reading -- "[AUTOTITLE](/code-security/getting-started/securing-your-repository)" -- "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)" +* "[AUTOTITLE](/code-security/getting-started/securing-your-repository)" +* "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)" diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md index 34fccb370a05..574a371cc132 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md @@ -21,13 +21,13 @@ shortTitle: Email notifications for pushes 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 {% data variables.product.product_name %} -- The author of the commit -- The date when the commit was made -- The files that were changed as part of the commit -- The commit message +* 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 {% data variables.product.product_name %} +* The author of the commit +* The date when the commit was made +* The files that were changed as part of the commit +* The commit message You can filter email notifications you receive for pushes to a repository. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#filtering-email-notifications)." @@ -42,4 +42,4 @@ You can filter email notifications you receive for pushes to a repository. For m ## Further reading -- "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)" +* "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)" diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md index aeb677403abc..f5c2a2a1ea18 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md @@ -23,8 +23,8 @@ Anyone with admin permissions to a repository can configure autolink references Autolink references can now accept alphanumeric characters. When originally introduced, custom autolinks were limited to external resources that used numeric identifiers. Custom autolinks now work with alphanumeric and numeric identifiers. You define custom autolinks by specifying a reference prefix and a target URL. -- Reference prefixes cannot have overlapping names. For example, a repository cannot have two custom autolinks with prefixes such as `TICKET` and `TICK`, since both prefixes would match the string `TICKET123a`. -- Target URLs include a `` variable which represents the reference identifier of the linked resource. +* Reference prefixes cannot have overlapping names. For example, a repository cannot have two custom autolinks with prefixes such as `TICKET` and `TICK`, since both prefixes would match the string `TICKET123a`. +* Target URLs include a `` variable which represents the reference identifier of the linked resource. {% endif %} ## Configuring autolinks to reference external resources @@ -45,6 +45,6 @@ This procedure demonstrates how to configure autolinks to reference external res 1. Review the preview and verify that the autolink and external reference are both correct, then click **Add autolink reference** to define the link. For example, you might enter the following. -- Reference prefix: `JIRA-` -- Target URL: `https://jira.example.com/issue?query=` -- Preview: `JIRA-123` is converted to `https://jira.example.com/issue?query=123` +* Reference prefix: `JIRA-` +* Target URL: `https://jira.example.com/issue?query=` +* Preview: `JIRA-123` is converted to `https://jira.example.com/issue?query=123` diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules.md index 942f138a6621..624e163e347c 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules.md @@ -30,10 +30,10 @@ You can import existing tag protection rules into repository rulesets. This will Rulesets have the following advantages over tag protection rules. -- Unlike protection rules, multiple rulesets can apply at the same time, so you can be confident that every rule targeting a tag in your repository will be evaluated when someone interacts with that tag. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets#about-rule-layering)." -- Rulesets have statuses, so you can easily manage which rulesets are active in a repository without needing to delete rulesets. -- Anyone with read access to a repository can view the active rulesets for the repository. This means a developer can understand why they have hit a rule, or an auditor can check the security constraints for the repository, without requiring admin access to the repository. -- With rulesets, you can restrict tag names on an organization-wide basis. +* Unlike protection rules, multiple rulesets can apply at the same time, so you can be confident that every rule targeting a tag in your repository will be evaluated when someone interacts with that tag. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets#about-rule-layering)." +* Rulesets have statuses, so you can easily manage which rulesets are active in a repository without needing to delete rulesets. +* Anyone with read access to a repository can view the active rulesets for the repository. This means a developer can understand why they have hit a rule, or an auditor can check the security constraints for the repository, without requiring admin access to the repository. +* With rulesets, you can restrict tag names on an organization-wide basis. {% endif %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md index c7eb7fdc03d8..863b749fa4c8 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md @@ -10,9 +10,9 @@ versions: shortTitle: Anonymous Git read access --- 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 repository. +* 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 repository. {% data reusables.enterprise_user_management.exceptions-for-enabling-anonymous-git-read-access %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md index 444745f2fb73..62352cfd08c6 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md @@ -67,5 +67,5 @@ For more information about repository roles, see "[AUTOTITLE](/account-and-profi ## Further reading -- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)" -- "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization)" +* "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)" +* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization)" diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md index f9ed68636793..86237e3c8878 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md @@ -25,5 +25,5 @@ You can help prevent sensitive information from being exposed by disabling the a ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" -- "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" +* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)" diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index 539d6c4c021b..854c0527a7d1 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md @@ -39,9 +39,9 @@ We recommend reviewing the following caveats before you change the visibility of **Warning:** Changes to the visibility of a large repository or repository network may affect data integrity. Visibility changes can also have unintended effects on forks. {% data variables.product.company_short %} recommends the following before changing the visibility of a repository network. -- Wait for a period of reduced activity on {% data variables.location.product_location %}. +* Wait for a period of reduced activity on {% data variables.location.product_location %}. -- Contact your site administrator before proceeding. Your site administrator can contact us for further assistance by visiting {% data variables.contact.contact_ent_support %}. +* Contact your site administrator before proceeding. Your site administrator can contact us for further assistance by visiting {% data variables.contact.contact_ent_support %}. {% endwarning %} @@ -49,35 +49,35 @@ We recommend reviewing the following caveats before you change the visibility of ### Making a repository private -- {% data variables.product.product_name %} will detach public forks of the public repository and put them into a new network. Public forks are not made private. +* {% data variables.product.product_name %} will detach public forks of the public repository and put them into a new network. Public forks are not made private. {%- ifversion ghes or ghec %} -- If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. The visibility of any forks will also change to private. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" +* If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. The visibility of any forks will also change to private. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" {%- endif %} {%- ifversion fpt %} -- If you're using {% data variables.product.prodname_free_user %} for personal accounts or organizations, some features won't be available in the repository after you change the visibility to private. Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-plans)" and "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site)." +* If you're using {% data variables.product.prodname_free_user %} for personal accounts or organizations, some features won't be available in the repository after you change the visibility to private. Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-plans)" and "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site)." {%- endif %} {%- ifversion fpt or ghec %} -- {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[AUTOTITLE](/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github#about-the-github-archive-program)." -- {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working{% ifversion ghec %} unless the repository is owned by an organization that is part of an enterprise with a license for {% data variables.product.prodname_advanced_security %} and sufficient spare seats{% endif %}. {% data reusables.advanced-security.more-info-ghas %} +* {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[AUTOTITLE](/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github#about-the-github-archive-program)." +* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working{% ifversion ghec %} unless the repository is owned by an organization that is part of an enterprise with a license for {% data variables.product.prodname_advanced_security %} and sufficient spare seats{% endif %}. {% data reusables.advanced-security.more-info-ghas %} {%- endif %} {%- ifversion ghes %} -- Anonymous Git read access is no longer available. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)." +* Anonymous Git read access is no longer available. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)." {%- endif %} {% ifversion ghes or ghec %} ### Making a repository internal -- Any forks of the repository will remain in the repository network, and {% data variables.product.product_name %} maintains the relationship between the root repository and the fork. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" +* Any forks of the repository will remain in the repository network, and {% data variables.product.product_name %} maintains the relationship between the root repository and the fork. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" {% endif %} ### Making a repository public -- {% data variables.product.product_name %} will detach private forks and turn them into a standalone private repository. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)"{% ifversion fpt or ghec %} -- If you're converting your private repository to a public repository as part of a move toward creating an open source project, see the [Open Source Guides](http://opensource.guide) for helpful tips and guidelines. You can also take a free course on managing an open source project with [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Once your repository is public, you can also view your repository's community profile to see whether your project meets best practices for supporting contributors. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." -- The repository will automatically gain access to {% data variables.product.prodname_GH_advanced_security %} features. -- Actions history and logs will be visible to everyone. If your repository had reusable or required workflows that were shared from a different repository in your organization, the workflow file path including the repository name will be visible in the logs. For more information on how to remove workflow runs and artifacts see "[AUTOTITLE](/actions/managing-workflow-runs#deleting-logs)" and "[AUTOTITLE](/rest/actions/workflow-runs)". +* {% data variables.product.product_name %} will detach private forks and turn them into a standalone private repository. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)"{% ifversion fpt or ghec %} +* If you're converting your private repository to a public repository as part of a move toward creating an open source project, see the [Open Source Guides](http://opensource.guide) for helpful tips and guidelines. You can also take a free course on managing an open source project with [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Once your repository is public, you can also view your repository's community profile to see whether your project meets best practices for supporting contributors. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." +* The repository will automatically gain access to {% data variables.product.prodname_GH_advanced_security %} features. +* Actions history and logs will be visible to everyone. If your repository had reusable or required workflows that were shared from a different repository in your organization, the workflow file path including the repository name will be visible in the logs. For more information on how to remove workflow runs and artifacts see "[AUTOTITLE](/actions/managing-workflow-runs#deleting-logs)" and "[AUTOTITLE](/rest/actions/workflow-runs)". For information about improving repository security, see "[AUTOTITLE](/code-security/getting-started/securing-your-repository)."{% endif %} @@ -92,4 +92,4 @@ For information about improving repository security, see "[AUTOTITLE](/code-secu ## Further reading -- "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" +* "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" diff --git a/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md b/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md index 8d998e36f9f5..de2b08379ece 100644 --- a/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md +++ b/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md @@ -104,4 +104,4 @@ changelog: ## Further reading -- "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels)" +* "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels)" diff --git a/content/repositories/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md b/content/repositories/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md index 5b8f4dec9453..cf38e21fa0e9 100644 --- a/content/repositories/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md +++ b/content/repositories/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md @@ -31,5 +31,5 @@ Query parameter | Example ## Further reading -- "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-url-query)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request)" +* "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-url-query)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request)" diff --git a/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md b/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md index 772ab2b279e6..90b70ae0ffe8 100644 --- a/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md +++ b/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md @@ -35,4 +35,4 @@ shortTitle: View releases & tags ## Further reading -- "[AUTOTITLE](/authentication/managing-commit-signature-verification/signing-tags)" +* "[AUTOTITLE](/authentication/managing-commit-signature-verification/signing-tags)" diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs.md b/content/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs.md index b6b70e8259ef..3f23387d7777 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs.md @@ -20,12 +20,12 @@ A repository's graphs give you information on {% ifversion fpt or ghec %} traffi {% ifversion fpt or ghec %} Some repository graphs are available only in public repositories with {% data variables.product.prodname_free_user %}: -- Pulse -- Contributors -- Traffic -- Commits -- Code frequency -- Network +* Pulse +* Contributors +* Traffic +* Commits +* Code frequency +* Network All other repository graphs are available in all repositories. Every repository graph is available in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, and {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md b/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md index f28586035578..900adbdd97bc 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md @@ -45,12 +45,12 @@ The network graph displays the branch history of the entire repository network, ## Listing the forks of a repository The{% ifversion repositories-forks-page-improvement %} forks page {% else %} Members graph {% endif %} lists the forks of a repository. {% ifversion repositories-forks-page-improvement %}For each fork, you can see: -- how many times the fork has been starred -- the number of direct forks (of the fork) -- the number of open issues -- the number of open pull requests -- when the fork was last updated (that is, the last push to any branch) -- when the fork was created +* how many times the fork has been starred +* the number of direct forks (of the fork) +* the number of open issues +* the number of open pull requests +* when the fork was last updated (that is, the last push to any branch) +* when the fork was created You can filter the list of forks to display active, inactive, starred, or archived forks, or to only display forks that have been updated within a specified time period (up to a period of five years). To view the most useful or most active forks, you can sort the list of forks by most starred forks or most recently updated forks, or by the number of open issues or open pull requests. diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository.md b/content/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository.md index 6265f1c19a85..17f28a899dcb 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository.md @@ -20,20 +20,20 @@ For each activity, you can view the exact changes by clicking "Compare changes." {% data reusables.repositories.navigate-to-repo %} 1. There are two ways to enter the activity view: - - On the main page of the repository, to the right of the list of files, click **{% octicon "pulse" aria-hidden="true" %} Activity**. + * On the main page of the repository, to the right of the list of files, click **{% octicon "pulse" aria-hidden="true" %} Activity**. - - Alternatively, click **{% octicon "git-branch" aria-hidden="true" %} Branches**, then to the right of any branch, click **{% octicon "pulse" aria-label="View branch activity" %}**. + * Alternatively, click **{% octicon "git-branch" aria-hidden="true" %} Branches**, then to the right of any branch, click **{% octicon "pulse" aria-label="View branch activity" %}**. ![Screenshot of a repository's branches view. To the right of a branch, the pulse icon is highlighted with a dark orange outline.](/assets/images/help/graphs/activity-view-icon.png) 1. Use the dropdown menus to filter the activity view. - - To see activity on a particular branch, select the **{% octicon "git-branch" aria-hidden="true" %} BRANCH NAME** dropdown menu, then click a branch name. Alternatively, within the dropdown menu, start typing a branch name into the search field. To view activity across all branches in the repository, click **View activity for all branches**. + * To see activity on a particular branch, select the **{% octicon "git-branch" aria-hidden="true" %} BRANCH NAME** dropdown menu, then click a branch name. Alternatively, within the dropdown menu, start typing a branch name into the search field. To view activity across all branches in the repository, click **View activity for all branches**. - - To filter by activity type, select the **{% octicon "pulse" aria-hidden="true" %} All activity** dropdown menu, then click an activity type. You can choose to display direct pushes, pull request merges, force pushes, branch creations, and branch deletions. + * To filter by activity type, select the **{% octicon "pulse" aria-hidden="true" %} All activity** dropdown menu, then click an activity type. You can choose to display direct pushes, pull request merges, force pushes, branch creations, and branch deletions. - - To filter by user, select the **{% octicon "people" aria-hidden="true" %} All users** dropdown menu, then click a username. Alternatively, within the dropdown menu, start typing a username into the search field. + * To filter by user, select the **{% octicon "people" aria-hidden="true" %} All users** dropdown menu, then click a username. Alternatively, within the dropdown menu, start typing a username into the search field. - - To filter by time, select the **{% octicon "clock" aria-hidden="true" %} All time** dropdown menu, then click a time period. + * To filter by time, select the **{% octicon "clock" aria-hidden="true" %} All time** dropdown menu, then click a time period. 1. Optionally, to see some additional details about the activity, such as the incoming branch name from a pull request, hover over the embedded link. diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md index c67597056521..591b3f926e2d 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md @@ -38,9 +38,9 @@ You can also see a list of people who have contributed to the project's Python d ## Troubleshooting contributors If you don't appear in a repository's contributors graph, it may be because: -- You aren't one of the top 100 contributors. -- Your commits haven't been merged into the default branch. -- The email address you used to author the commits isn't connected to your account on {% data variables.product.product_name %}. +* You aren't one of the top 100 contributors. +* Your commits haven't been merged into the default branch. +* The email address you used to author the commits isn't connected to your account on {% data variables.product.product_name %}. {% tip %} diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md index 6b6f5f12f57b..6f511cbec902 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md @@ -32,4 +32,4 @@ You can also see deployment information on the "Conversation" tab of a pull requ ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" diff --git a/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md b/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md index bb114a4b365f..fa8eaa8d5711 100644 --- a/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md +++ b/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md @@ -87,5 +87,5 @@ You can upload an existing file to a repository on {% data variables.location.pr ## Further reading -- "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github)" +* "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github)" {% endif %} diff --git a/content/repositories/working-with-files/managing-files/creating-new-files.md b/content/repositories/working-with-files/managing-files/creating-new-files.md index b642082e0f74..9c8a29c9f899 100644 --- a/content/repositories/working-with-files/managing-files/creating-new-files.md +++ b/content/repositories/working-with-files/managing-files/creating-new-files.md @@ -14,10 +14,10 @@ topics: --- When creating a file on {% data variables.product.product_name %}, consider the following: -- If you try to create a new file in a repository that you don’t have access to, we will fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. -- File names created via the web interface can only contain alphanumeric characters and hyphens (`-`). To use other characters, [create and commit the files locally, then push them to the repository on {% data variables.product.product_name %}](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository). +* If you try to create a new file in a repository that you don’t have access to, we will fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. +* File names created via the web interface can only contain alphanumeric characters and hyphens (`-`). To use other characters, [create and commit the files locally, then push them to the repository on {% data variables.product.product_name %}](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository). {%- ifversion push-rulesets %} -- {% data reusables.repositories.rulesets-push-rules-general-info-for-related-articles %} +* {% data reusables.repositories.rulesets-push-rules-general-info-for-related-articles %} {% endif %} {% data reusables.repositories.sensitive-info-warning %} diff --git a/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md b/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md index b7636235cf6c..3911b7859c1f 100644 --- a/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md +++ b/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md @@ -26,5 +26,5 @@ Use a _.gitattributes_ file to mark files that match a given "pattern" with the ## Further reading -- "[Generated code](https://github.com/github-linguist/linguist/blob/master/docs/overrides.md#generated-code)" in the Linguist documentation -- "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)" +* "[Generated code](https://github.com/github-linguist/linguist/blob/master/docs/overrides.md#generated-code)" in the Linguist documentation +* "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)" diff --git a/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md index 8017d0c3f1ec..0262bd031847 100644 --- a/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md +++ b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md @@ -24,17 +24,17 @@ In addition to changing the file location, you can also [update the contents of **Tips**: -- If you try to move a file in a repository that you don’t have access to, we'll fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. -- Some files, such as images, require that you move them from the command line. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location)". -- {% data reusables.repositories.protected-branches-block-web-edits-uploads %} +* If you try to move a file in a repository that you don’t have access to, we'll fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. +* Some files, such as images, require that you move them from the command line. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location)". +* {% data reusables.repositories.protected-branches-block-web-edits-uploads %} {% endtip %} 1. In your repository, browse to the file you want to move. {% data reusables.repositories.edit-file %} 1. In the filename field, change the name of the file using these guidelines: - - To move the file **into a subfolder**, type the name of the folder you want, followed by `/`. Your new folder name becomes a new item in the navigation breadcrumbs. - - To move the file into a directory **above the file's current location**, place your cursor at the beginning of the filename field, then either type `../` to jump up one full directory level, or type the `backspace` key to edit the parent folder's name. + * To move the file **into a subfolder**, type the name of the folder you want, followed by `/`. Your new folder name becomes a new item in the navigation breadcrumbs. + * To move the file into a directory **above the file's current location**, place your cursor at the beginning of the filename field, then either type `../` to jump up one full directory level, or type the `backspace` key to edit the parent folder's name. {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_file_change %} diff --git a/content/repositories/working-with-files/managing-files/renaming-a-file.md b/content/repositories/working-with-files/managing-files/renaming-a-file.md index f016436fc365..b7329db9670d 100644 --- a/content/repositories/working-with-files/managing-files/renaming-a-file.md +++ b/content/repositories/working-with-files/managing-files/renaming-a-file.md @@ -24,9 +24,9 @@ Renaming a file also gives you the opportunity to [move the file to a new locati **Tips**: -- If you try to rename a file in a repository that you don’t have access to, we will fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. -- File names created via the web interface can only contain alphanumeric characters and hyphens (`-`). To use other characters, create and commit the files locally and then push them to the repository. -- Some files, such as images, require that you rename them from the command line. For more information, see "[Renaming a file using the command line](#renaming-a-file-using-the-command-line)." +* If you try to rename a file in a repository that you don’t have access to, we will fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. +* File names created via the web interface can only contain alphanumeric characters and hyphens (`-`). To use other characters, create and commit the files locally and then push them to the repository. +* Some files, such as images, require that you rename them from the command line. For more information, see "[Renaming a file using the command line](#renaming-a-file-using-the-command-line)." {% endtip %} diff --git a/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md index b7301e948d12..ad3b4e604300 100644 --- a/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md @@ -50,11 +50,11 @@ It tracks the `version` of {% data variables.large_files.product_name_short %} y {% note %} **Notes**: -- {% data variables.large_files.product_name_short %} cannot be used with {% data variables.product.prodname_pages %} sites. -- {% data variables.large_files.product_name_short %} cannot be used with template repositories. +* {% data variables.large_files.product_name_short %} cannot be used with {% data variables.product.prodname_pages %} sites. +* {% data variables.large_files.product_name_short %} cannot be used with template repositories. {% endnote %} ## Further reading -- "[AUTOTITLE](/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage)" +* "[AUTOTITLE](/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage)" diff --git a/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md b/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md index 68564466f148..79fffcd7e99c 100644 --- a/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md +++ b/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md @@ -19,9 +19,9 @@ shortTitle: Storage & bandwidth When you commit and push a change to a file tracked with {% data variables.large_files.product_name_short %}, a new version of the entire file is pushed and the total file size is counted against the repository owner's storage limit. When you download a file tracked with {% data variables.large_files.product_name_short %}, the total file size is counted against the repository owner's bandwidth limit. {% data variables.large_files.product_name_short %} uploads do not count against the bandwidth limit. For example: -- If you push a 500 MB file to {% data variables.large_files.product_name_short %}, you'll use 500 MB of your allotted storage and none of your bandwidth. If you make a 1 byte change and push the file again, you'll use another 500 MB of storage and no bandwidth, bringing your total usage for these two pushes to 1 GB of storage and zero bandwidth. -- If you download a 500 MB file that's tracked with LFS, you'll use 500 MB of the repository owner's allotted bandwidth. If a collaborator pushes a change to the file and you pull the new version to your local repository, you'll use another 500 MB of bandwidth, bringing the total usage for these two downloads to 1 GB of bandwidth. -- If {% data variables.product.prodname_actions %} downloads a 500 MB file that is tracked with LFS, it will use 500 MB of the repository owner's allotted bandwidth. +* If you push a 500 MB file to {% data variables.large_files.product_name_short %}, you'll use 500 MB of your allotted storage and none of your bandwidth. If you make a 1 byte change and push the file again, you'll use another 500 MB of storage and no bandwidth, bringing your total usage for these two pushes to 1 GB of storage and zero bandwidth. +* If you download a 500 MB file that's tracked with LFS, you'll use 500 MB of the repository owner's allotted bandwidth. If a collaborator pushes a change to the file and you pull the new version to your local repository, you'll use another 500 MB of bandwidth, bringing the total usage for these two downloads to 1 GB of bandwidth. +* If {% data variables.product.prodname_actions %} downloads a 500 MB file that is tracked with LFS, it will use 500 MB of the repository owner's allotted bandwidth. {% ifversion fpt or ghec %} If {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}) objects are included in [source code archives](/repositories/working-with-files/using-files/downloading-source-code-archives) for your repository, downloads of those archives will count towards bandwidth usage for the repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository)." @@ -30,8 +30,8 @@ If {% data variables.large_files.product_name_long %} ({% data variables.large_f {% tip %} **Tips**: -- {% data reusables.large_files.owner_quota_only %} -- {% data reusables.large_files.does_not_carry %} +* {% data reusables.large_files.owner_quota_only %} +* {% data reusables.large_files.does_not_carry %} {% endtip %} @@ -45,5 +45,5 @@ If you use more than {% data variables.large_files.initial_bandwidth_quota %} of ## Further reading -- "[AUTOTITLE](/billing/managing-billing-for-git-large-file-storage/viewing-your-git-large-file-storage-usage)" -- "[AUTOTITLE](/billing/managing-billing-for-git-large-file-storage)" +* "[AUTOTITLE](/billing/managing-billing-for-git-large-file-storage/viewing-your-git-large-file-storage-usage)" +* "[AUTOTITLE](/billing/managing-billing-for-git-large-file-storage)" diff --git a/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md index 3c23f1933378..d59b0b05af13 100644 --- a/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md @@ -46,4 +46,4 @@ You can push {% data variables.large_files.product_name_short %} objects to publ ## Further reading -- "[AUTOTITLE](/repositories/creating-and-managing-repositories/duplicating-a-repository#mirroring-a-repository-that-contains-git-large-file-storage-objects)" +* "[AUTOTITLE](/repositories/creating-and-managing-repositories/duplicating-a-repository#mirroring-a-repository-that-contains-git-large-file-storage-objects)" diff --git a/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md index 4e31d1aaaa60..3e2daee9069d 100644 --- a/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md @@ -43,9 +43,9 @@ If there are existing files in your repository that you'd like to use {% data va **Note:** We strongly suggest that you commit your local _.gitattributes_ file into your repository. - - Relying on a global _.gitattributes_ file associated with {% data variables.large_files.product_name_short %} may cause conflicts when contributing to other Git projects. - - Including the _.gitattributes_ file in the repository allows people creating forks or fresh clones to more easily collaborate using {% data variables.large_files.product_name_short %}. - - Including the _.gitattributes_ file in the repository allows {% data variables.large_files.product_name_short %} objects to optionally be included in ZIP file and tarball archives. + * Relying on a global _.gitattributes_ file associated with {% data variables.large_files.product_name_short %} may cause conflicts when contributing to other Git projects. + * Including the _.gitattributes_ file in the repository allows people creating forks or fresh clones to more easily collaborate using {% data variables.large_files.product_name_short %}. + * Including the _.gitattributes_ file in the repository allows {% data variables.large_files.product_name_short %} objects to optionally be included in ZIP file and tarball archives. {% endnote %} @@ -72,5 +72,5 @@ If there are existing files in your repository that you'd like to use {% data va ## Further reading -- "[AUTOTITLE](/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage)"{% ifversion fpt or ghec %} -- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository)"{% endif %} +* "[AUTOTITLE](/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage)"{% ifversion fpt or ghec %} +* "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository)"{% endif %} diff --git a/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md index 842d1ea8af7b..d15c4c49e56b 100644 --- a/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md @@ -15,8 +15,8 @@ shortTitle: Install Git LFS {% mac %} 1. Navigate to [git-lfs.com](https://git-lfs.com) and click **Download**. Alternatively, you can install {% data variables.large_files.product_name_short %} using a package manager: - - To use [Homebrew](https://brew.sh/), run `brew install git-lfs`. - - To use [MacPorts](https://www.macports.org/), run `port install git-lfs`. + * To use [Homebrew](https://brew.sh/), run `brew install git-lfs`. + * To use [MacPorts](https://www.macports.org/), run `port install git-lfs`. If you install {% data variables.large_files.product_name_short %} with Homebrew or MacPorts, skip to step six. @@ -126,4 +126,4 @@ shortTitle: Install Git LFS ## Further reading -- "[AUTOTITLE](/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage)" +* "[AUTOTITLE](/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage)" diff --git a/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md index 9ecb90b12e82..f8006c95b6bc 100644 --- a/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md @@ -26,6 +26,6 @@ After installing {% data variables.large_files.product_name_short %} and configu ## Further reading -- "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-git-large-file-storage)" -- "[AUTOTITLE](/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage)" -- "[AUTOTITLE](/repositories/working-with-files/managing-large-files/installing-git-large-file-storage)" +* "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-git-large-file-storage)" +* "[AUTOTITLE](/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage)" +* "[AUTOTITLE](/repositories/working-with-files/managing-large-files/installing-git-large-file-storage)" diff --git a/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md index 6995353f07c5..1f9d8ac9f453 100644 --- a/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md @@ -53,6 +53,6 @@ To remove {% data variables.large_files.product_name_short %} objects from a rep ## Further reading -- "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-git-large-file-storage)" -- "[AUTOTITLE](/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage)" -- "[AUTOTITLE](/repositories/working-with-files/managing-large-files/installing-git-large-file-storage)" +* "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-git-large-file-storage)" +* "[AUTOTITLE](/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage)" +* "[AUTOTITLE](/repositories/working-with-files/managing-large-files/installing-git-large-file-storage)" diff --git a/content/repositories/working-with-files/using-files/downloading-source-code-archives.md b/content/repositories/working-with-files/using-files/downloading-source-code-archives.md index 29c2e8de975c..fb9b2040bc26 100644 --- a/content/repositories/working-with-files/using-files/downloading-source-code-archives.md +++ b/content/repositories/working-with-files/using-files/downloading-source-code-archives.md @@ -59,10 +59,10 @@ Source code archives are available at specific URLs for each repository. For exa Source code archives are generated on request, cached for a while, and then deleted. If the same archive is requested again in the future, it'll be regenerated. It's important to understand what guarantees {% data variables.product.company_short %} makes about source code archives. -- An archive of a commit ID will always have the same file contents whenever it's requested, assuming the commit ID is still in the repository and the repository's name has not changed. -- Because branches and tags can move to different commit IDs, future downloads of an archive may have different contents than previously downloaded archives of the same branch or tag. Assuming the branch or tag still points at the same commit ID, it will have the same file contents. -- The exact compression settings used to generate a zipball or tarball may change over time. The extracted contents won't change if the branch or tag doesn't change, but the outer compressed archive may have a different byte layout. {% data variables.product.company_short %} will give at least six months' notice before changing compression settings. -- The name of the repository is part of the directory structure inside the archive. Therefore, if the repository name changes, the root directory name will change as well. +* An archive of a commit ID will always have the same file contents whenever it's requested, assuming the commit ID is still in the repository and the repository's name has not changed. +* Because branches and tags can move to different commit IDs, future downloads of an archive may have different contents than previously downloaded archives of the same branch or tag. Assuming the branch or tag still points at the same commit ID, it will have the same file contents. +* The exact compression settings used to generate a zipball or tarball may change over time. The extracted contents won't change if the branch or tag doesn't change, but the outer compressed archive may have a different byte layout. {% data variables.product.company_short %} will give at least six months' notice before changing compression settings. +* The name of the repository is part of the directory structure inside the archive. Therefore, if the repository name changes, the root directory name will change as well. If you rely on stability of source code archives for reproducibility (ensuring you always get identical files inside the archive), we recommend using the [archives REST API](/rest/repos/contents#download-a-repository-archive-tar) with a commit ID for `:ref`. Using the commit ID ensures you'll always get the same file contents inside the archive and you’ll be immune to repositories rewriting tags or moving branch heads. diff --git a/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md b/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md index 4412255f597d..9971fbcf231c 100644 --- a/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md +++ b/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md @@ -25,7 +25,7 @@ shortTitle: Permanent links to files When viewing a file on {% data variables.location.product_location %}, you usually see the version at the current head of a branch. For example: -- [https://github.com/github/codeql/blob/**main**/README.md](https://github.com/github/codeql/blob/main/README.md) +* [https://github.com/github/codeql/blob/**main**/README.md](https://github.com/github/codeql/blob/main/README.md) refers to GitHub's `codeql` repository, and shows the `main` branch's current version of the `README.md` file. @@ -35,7 +35,7 @@ The version of a file at the head of branch can change as new commits are made, For a permanent link to the specific version of a file that you see, instead of using a branch name in the URL (i.e. the `main` part in the example above), put a commit ID. This will permanently link to the exact version of the file in that commit. For example: -- [https://github.com/github/codeql/blob/**b212af08a6cffbb434f3c8a2795a579e092792fd**/README.md](https://github.com/github/codeql/blob/b212af08a6cffbb434f3c8a2795a579e092792fd/README.md) +* [https://github.com/github/codeql/blob/**b212af08a6cffbb434f3c8a2795a579e092792fd**/README.md](https://github.com/github/codeql/blob/b212af08a6cffbb434f3c8a2795a579e092792fd/README.md) replaces `main` with a specific commit ID and the file content will not change. @@ -53,4 +53,4 @@ You can create a permanent link to a specific line or range of lines of code in ## Further reading -- "[AUTOTITLE](/repositories/archiving-a-github-repository)" +* "[AUTOTITLE](/repositories/archiving-a-github-repository)" diff --git a/content/repositories/working-with-files/using-files/navigating-code-on-github.md b/content/repositories/working-with-files/using-files/navigating-code-on-github.md index 8dd2eb3e399a..db73f270c34e 100644 --- a/content/repositories/working-with-files/using-files/navigating-code-on-github.md +++ b/content/repositories/working-with-files/using-files/navigating-code-on-github.md @@ -51,8 +51,8 @@ Code navigation uses the open source [`tree-sitter`](https://github.com/tree-sit You do not need to configure anything in your repository to enable code navigation. We will automatically extract search-based and precise code navigation information for these supported languages in all repositories and you can switch between the two supported code navigation approaches if your programming language is supported by both. {% data variables.product.prodname_dotcom %} has developed two code navigation approaches based on the open source [`tree-sitter`](https://github.com/tree-sitter/tree-sitter) and [`stack-graphs`](https://github.com/github/stack-graphs) library: -- Search-based - searches all definitions and references across a repository to find entities with a given name -- Precise - resolves definitions and references based on the set of classes, functions, and imported definitions at a given point in your code +* Search-based - searches all definitions and references across a repository to find entities with a given name +* Precise - resolves definitions and references based on the set of classes, functions, and imported definitions at a given point in your code To learn more about these approaches, see "[Precise and search-based navigation](#precise-and-search-based-navigation)." @@ -75,7 +75,7 @@ Symbol search is a feature of code search. For more information, see "[AUTOTITLE 1. Click the symbol you would like to find from the symbols pane or within the file itself. - - To search for a symbol in the repository as a whole, in the symbols pane, click **Search for this symbol in this repository**. To search for a symbol in all repositories on {% data variables.product.prodname_dotcom %}, click **all repositories**. + * To search for a symbol in the repository as a whole, in the symbols pane, click **Search for this symbol in this repository**. To search for a symbol in all repositories on {% data variables.product.prodname_dotcom %}, click **all repositories**. 1. To navigate between references to a symbol, click {% octicon "chevron-down" aria-label="The downwards-facing chevron icon" %} or {% octicon "chevron-up" aria-label="The upwards-facing chevron icon" %}. 1. To navigate to a specific reference to a symbol, click a result of the symbol search under {% octicon "chevron-down" aria-label="The downwards-facing chevron icon" %} **In this file**. @@ -113,9 +113,9 @@ Cross-repo code navigation is available for languages that are supported by prec ## Troubleshooting code navigation If code navigation is enabled for you but you don't see links to the definitions of functions and methods: -- Code navigation only works for active branches. Push to the branch and try again. -- Code navigation only works for repositories with fewer than 100,000 files. +* Code navigation only works for active branches. Push to the branch and try again. +* Code navigation only works for repositories with fewer than 100,000 files. ## Further reading -- "[AUTOTITLE]{% ifversion code-search-upgrade %}(/search-github/github-code-search/about-github-code-search){% else %}(/search-github/searching-on-github/searching-code){% endif %}" +* "[AUTOTITLE]{% ifversion code-search-upgrade %}(/search-github/github-code-search/about-github-code-search){% else %}(/search-github/searching-on-github/searching-code){% endif %}" diff --git a/content/repositories/working-with-files/using-files/viewing-a-file.md b/content/repositories/working-with-files/using-files/viewing-a-file.md index 25ca00913d89..d96454feda8f 100644 --- a/content/repositories/working-with-files/using-files/viewing-a-file.md +++ b/content/repositories/working-with-files/using-files/viewing-a-file.md @@ -51,7 +51,7 @@ Within the blame view, you can view the line-by-line revision history for an ent ![Screenshot of a commit in the blame view. The commit message and versions icon are outlined in dark orange.](/assets/images/help/repository/code-view-blame-commit-options.png) 1. To return to the raw code view, above the file content, click **Code**. - - If you are viewing a Markdown file, above the file content, you can also click **Preview** to return to the view with Markdown formatting applied. + * If you are viewing a Markdown file, above the file content, you can also click **Preview** to return to the view with Markdown formatting applied. {% else %} 1. In the upper-right corner of the file view, click **Blame** to open the blame view. diff --git a/content/repositories/working-with-files/using-files/working-with-non-code-files.md b/content/repositories/working-with-files/using-files/working-with-non-code-files.md index fc2f8411034c..a14f97208c47 100644 --- a/content/repositories/working-with-files/using-files/working-with-non-code-files.md +++ b/content/repositories/working-with-files/using-files/working-with-non-code-files.md @@ -41,8 +41,8 @@ shortTitle: Working with non-code files {% note %} **Note:** -- {% data variables.product.prodname_dotcom %} does not support comparing the differences between PSD files. -- If you are using the Firefox browser, SVGs on {% data variables.product.prodname_dotcom %} may not render. +* {% data variables.product.prodname_dotcom %} does not support comparing the differences between PSD files. +* If you are using the Firefox browser, SVGs on {% data variables.product.prodname_dotcom %} may not render. {% endnote %} @@ -78,10 +78,10 @@ You can visually compare images in three different modes: [2-up](#2-up), [swipe] When looking directly at an STL file on {% data variables.product.product_name %} you can: -- Click and drag to spin the model. -- Right click and drag to translate the view. -- Scroll to zoom in and out. -- Click the different view modes to change the view. +* Click and drag to spin the model. +* Right click and drag to translate the view. +* Scroll to zoom in and out. +* Click the different view modes to change the view. ### Fixing slow performance @@ -141,9 +141,9 @@ Occasionally, you may discover that your CSV or TSV file isn't rendering. In tho Common errors include: -- Mismatched column counts. You must have the same number of separators in each row, even if the cell is blank -- Exceeding the file size. Our rendering only works for files up to 512KB. Anything bigger than that slows down the browser. -- Using unsupported delimiters, such as semicolons instead of commas. +* Mismatched column counts. You must have the same number of separators in each row, even if the cell is blank +* Exceeding the file size. Our rendering only works for files up to 512KB. Anything bigger than that slows down the browser. +* Using unsupported delimiters, such as semicolons instead of commas. ## Rendering PDF documents @@ -161,15 +161,15 @@ this might be the difference between showing `**bold**` in Markdown, and **bold* Prose rendering is supported for rendered documents supported by [github/markup](https://github.com/github/markup): -- Markdown -- AsciiDoc -- Textile -- ReStructuredText -- Rdoc -- Org -- Creole -- MediaWiki -- Pod +* Markdown +* AsciiDoc +* Textile +* ReStructuredText +* Rdoc +* Org +* Creole +* MediaWiki +* Pod To see the changes made to the document as part of a commit, click {% octicon "file" aria-label="Display the rich diff" %}. @@ -228,14 +228,14 @@ Maps on {% data variables.product.product_name %} use [Leaflet.js](http://leafle You can customize the way features are displayed, such as specifying a particular color or adding a descriptive icon, by passing additional metadata within the GeoJSON object's properties. The options are: -- `marker-size` - `small`, `medium`, or `large` -- `marker-color` - valid RGB hex color -- `marker-symbol` - an icon ID from [the Maki project](https://mapbox.com/maki/) or a single alphanumeric character (a-z or 0-9). -- `stroke` - color of a polygon edge or line (RGB) -- `stroke-opacity` - opacity of a polygon edge or line (0.0 - 1.0) -- `stroke-width` - width of a polygon edge or line -- `fill` - the color of the interior of a polygon (GRB) -- `fill-opacity` - the opacity of the interior of a polygon (0.0-1.0) +* `marker-size` - `small`, `medium`, or `large` +* `marker-color` - valid RGB hex color +* `marker-symbol` - an icon ID from [the Maki project](https://mapbox.com/maki/) or a single alphanumeric character (a-z or 0-9). +* `stroke` - color of a polygon edge or line (RGB) +* `stroke-opacity` - opacity of a polygon edge or line (0.0 - 1.0) +* `stroke-width` - width of a polygon edge or line +* `fill` - the color of the interior of a polygon (GRB) +* `fill-opacity` - the opacity of the interior of a polygon (0.0-1.0) See [version 1.1.0 of the open simplestyle spec](https://github.com/mapbox/simplestyle-spec/tree/master/1.1.0) for more information. {% endif %} @@ -287,12 +287,12 @@ It may still be possible to render the data by converting the `.geojson` file to ### Further reading about GeoJSON/TopoJSON {% ifversion geoJSON-with-MapBox %} -- [Leaflet.js documentation](https://leafletjs.com/) -- [MapBox marker-styling documentation](http://www.mapbox.com/developers/simplestyle/) +* [Leaflet.js documentation](https://leafletjs.com/) +* [MapBox marker-styling documentation](http://www.mapbox.com/developers/simplestyle/) {%- else %} -- [Azure Maps documentation](https://docs.microsoft.com/en-us/azure/azure-maps/) +* [Azure Maps documentation](https://docs.microsoft.com/en-us/azure/azure-maps/) {%- endif %} -- [TopoJSON Wiki](https://github.com/mbostock/topojson/wiki) +* [TopoJSON Wiki](https://github.com/mbostock/topojson/wiki) ## Working with Jupyter Notebook files on {% data variables.product.prodname_dotcom %} @@ -314,8 +314,8 @@ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb ### Further reading about Jupyter Notebook -- [Jupyter Notebook's GitHub repository](https://github.com/jupyter/jupyter_notebook) -- [Gallery of Jupyter Notebooks](https://github.com/jupyter/jupyter/wiki) +* [Jupyter Notebook's GitHub repository](https://github.com/jupyter/jupyter_notebook) +* [Gallery of Jupyter Notebooks](https://github.com/jupyter/jupyter/wiki) ## Displaying Mermaid files on {% data variables.product.prodname_dotcom %} @@ -344,9 +344,9 @@ If the chart displays, but does not appear as you'd expect, you can create a new #### Known issues -- Sequence diagram charts frequently render with additional padding below the chart, with more padding added as the chart size increases. This is a known issue with the Mermaid library. -- Actor nodes with popover menus do not work as expected within sequence diagram charts. This is due to a discrepancy in how JavaScript events are added to a chart when the Mermaid library's API is used to render a chart. -- Not all charts are a11y compliant. This may affect users who rely on a screen reader. +* Sequence diagram charts frequently render with additional padding below the chart, with more padding added as the chart size increases. This is a known issue with the Mermaid library. +* Actor nodes with popover menus do not work as expected within sequence diagram charts. This is due to a discrepancy in how JavaScript events are added to a chart when the Mermaid library's API is used to render a chart. +* Not all charts are a11y compliant. This may affect users who rely on a screen reader. ### Mermaid in Markdown @@ -354,5 +354,5 @@ You can embed Mermaid syntax directly in Markdown. For more information, see "[A ### Further reading about Mermaid -- [Mermaid.js documentation](https://mermaid-js.github.io/mermaid/#/) -- [Mermaid.js live editor](https://mermaid.live/edit) +* [Mermaid.js documentation](https://mermaid-js.github.io/mermaid/#/) +* [Mermaid.js live editor](https://mermaid.live/edit) diff --git a/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md b/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md index ca9fd13d023d..ae62ca2f9d32 100644 --- a/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md +++ b/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md @@ -33,8 +33,8 @@ Each description is available in a bundled or in a dereferenced format. The bund Because the OpenAPI description is machine readable, you can use it to do things like: -- Generate libraries to facilitate using the REST API -- Validate and test an integration that uses the REST API -- Explore and interact with the REST API using third-party tools, such as Insomnia or Postman +* Generate libraries to facilitate using the REST API +* Validate and test an integration that uses the REST API +* Explore and interact with the REST API using third-party tools, such as Insomnia or Postman For example, {% data variables.product.company_short %} uses the OpenAPI description to generate the Octokit SDKs. {% data variables.product.company_short %} also uses the OpenAPI description to generate the REST API reference documentation for each endpoint. diff --git a/content/rest/about-the-rest-api/about-the-rest-api.md b/content/rest/about-the-rest-api/about-the-rest-api.md index ebf97cb25e83..91872947f5d3 100644 --- a/content/rest/about-the-rest-api/about-the-rest-api.md +++ b/content/rest/about-the-rest-api/about-the-rest-api.md @@ -20,20 +20,20 @@ Each REST API endpoint is documented individually, and the endpoints are categor **If you are new to REST APIs**, you may find it helpful to refer to the Quickstart or Getting Started guide for an introduction. For more information, see: -- "[AUTOTITLE](/rest/quickstart)" -- "[AUTOTITLE](/rest/guides/getting-started-with-the-rest-api)" +* "[AUTOTITLE](/rest/quickstart)" +* "[AUTOTITLE](/rest/guides/getting-started-with-the-rest-api)" **If you are familiar with REST APIs** but new to {% data variables.product.company_short %}'s REST API, you may find it helpful to refer to the authentication documentation. For more information, see: -- "[AUTOTITLE](/rest/overview/authenticating-to-the-rest-api)" +* "[AUTOTITLE](/rest/overview/authenticating-to-the-rest-api)" **If you are building scripts or applications** that use the REST API, you may find some of the following guides helpful. For examples of scripting with the REST API, see: -- "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript)" -- "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-ruby)" -- "[AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events)" -- "[AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-a-cli-with-a-github-app)" -- "[AUTOTITLE](/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook)" +* "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript)" +* "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-ruby)" +* "[AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events)" +* "[AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-a-cli-with-a-github-app)" +* "[AUTOTITLE](/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook)" For a list of libraries to facilitate scripting with the REST API, see "[AUTOTITLE](/rest/overview/libraries-for-the-rest-api)." @@ -41,7 +41,7 @@ If you are building scripts or applications that use the REST API, you might als ## Further reading -- "[AUTOTITLE](/rest/overview/comparing-githubs-rest-api-and-graphql-api)" -- "[AUTOTITLE](/rest/guides/best-practices-for-using-the-rest-api)" -- "[AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure)" -- "[AUTOTITLE](/rest/overview/troubleshooting-the-rest-api)" +* "[AUTOTITLE](/rest/overview/comparing-githubs-rest-api-and-graphql-api)" +* "[AUTOTITLE](/rest/guides/best-practices-for-using-the-rest-api)" +* "[AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure)" +* "[AUTOTITLE](/rest/overview/troubleshooting-the-rest-api)" diff --git a/content/rest/authentication/authenticating-to-the-rest-api.md b/content/rest/authentication/authenticating-to-the-rest-api.md index 87e00656449e..daa181b2a856 100644 --- a/content/rest/authentication/authenticating-to-the-rest-api.md +++ b/content/rest/authentication/authenticating-to-the-rest-api.md @@ -92,8 +92,8 @@ If you are the owner of a {% data variables.product.prodname_github_app %} or {% 1. In the upper-right corner of any page on {% data variables.product.prodname_dotcom %}, click your profile photo. 1. Navigate to your account settings. - - For an app owned by a personal account, click **Settings**. - - For an app owned by an organization: + * For an app owned by a personal account, click **Settings**. + * For an app owned by an organization: 1. Click **Your organizations**. 1. To the right of the organization, click **Settings**. {% data reusables.user-settings.developer_settings %} @@ -171,5 +171,5 @@ Authentication with username and password is not supported. If you try to authen ## Further reading -- "[AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure)" -- "[AUTOTITLE](/rest/guides/getting-started-with-the-rest-api#authenticating)" +* "[AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure)" +* "[AUTOTITLE](/rest/guides/getting-started-with-the-rest-api#authenticating)" diff --git a/content/rest/authentication/keeping-your-api-credentials-secure.md b/content/rest/authentication/keeping-your-api-credentials-secure.md index dd8e94728808..04e2511b29d4 100644 --- a/content/rest/authentication/keeping-your-api-credentials-secure.md +++ b/content/rest/authentication/keeping-your-api-credentials-secure.md @@ -16,9 +16,9 @@ redirect_from: You should choose an authentication method that is appropriate for the task you want to accomplish. -- To use the API for personal use, you can create a {% data variables.product.pat_generic %}. -- To use the API on behalf of an organization or another user, you should create a {% data variables.product.prodname_github_app %}. -- To use the API in a {% data variables.product.prodname_actions %} workflow, you should authenticate with the built-in `GITHUB_TOKEN`. +* To use the API for personal use, you can create a {% data variables.product.pat_generic %}. +* To use the API on behalf of an organization or another user, you should create a {% data variables.product.prodname_github_app %}. +* To use the API in a {% data variables.product.prodname_actions %} workflow, you should authenticate with the built-in `GITHUB_TOKEN`. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github#authenticating-with-the-api)." @@ -42,10 +42,10 @@ When authenticating with `GITHUB_TOKEN` in a {% data variables.product.prodname_ Treat authentication credentials the same way you would treat your passwords or other sensitive credentials. -- Don't share authentication credentials using an unencrypted messaging or email system. -- Don't pass your {% data variables.product.pat_generic %} as plain text in the command line. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#keeping-your-personal-access-tokens-secure)." -- Don't push unencrypted authentication credentials like tokens or keys to any repository, even if the repository is private. Instead consider using a {% data variables.product.prodname_actions %} secret{% ifversion fpt or ghec %} or Codespaces secret{% endif %}. For more information, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)"{% ifversion fpt or ghec %} and "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)"{% endif %}. -- You can use secret scanning to discover tokens, private keys, and other secrets that were pushed to a repository, or to block future pushes that contain secrets. For more information, see "[AUTOTITLE](/code-security/secret-scanning/about-secret-scanning)." +* Don't share authentication credentials using an unencrypted messaging or email system. +* Don't pass your {% data variables.product.pat_generic %} as plain text in the command line. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#keeping-your-personal-access-tokens-secure)." +* Don't push unencrypted authentication credentials like tokens or keys to any repository, even if the repository is private. Instead consider using a {% data variables.product.prodname_actions %} secret{% ifversion fpt or ghec %} or Codespaces secret{% endif %}. For more information, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)"{% ifversion fpt or ghec %} and "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)"{% endif %}. +* You can use secret scanning to discover tokens, private keys, and other secrets that were pushed to a repository, or to block future pushes that contain secrets. For more information, see "[AUTOTITLE](/code-security/secret-scanning/about-secret-scanning)." ## Limit who can access your authentication credentials @@ -67,9 +67,9 @@ If none of these options are possible, you can store authentication credentials You should create a plan to handle any security breaches in a timely manner. In the event that your token or other authentication credential is leaked, you will need to: -- Generate a new credential. -- Replace the old credential with the new one everywhere that you are storing or accessing the credential. -- Delete the old compromised credential. +* Generate a new credential. +* Replace the old credential with the new one everywhere that you are storing or accessing the credential. +* Delete the old compromised credential. For information about rotating compromised credentials for a {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app)." diff --git a/content/rest/deploy-keys/deploy-keys.md b/content/rest/deploy-keys/deploy-keys.md index f9c9467a4b13..68d78c686190 100644 --- a/content/rest/deploy-keys/deploy-keys.md +++ b/content/rest/deploy-keys/deploy-keys.md @@ -22,13 +22,13 @@ Deploy keys can either be set up using the following API endpoints, or by using There are a few cases when a deploy key will be deleted by other activity: -- If the deploy key is created with a {% data variables.product.pat_generic %}, deleting the {% data variables.product.pat_generic %} will also delete the deploy key. Regenerating the {% data variables.product.pat_generic %} will not delete the deploy key. -- If the deploy key is created with an {% data variables.product.prodname_oauth_app %} token, revoking the token will also delete the deploy key. +* If the deploy key is created with a {% data variables.product.pat_generic %}, deleting the {% data variables.product.pat_generic %} will also delete the deploy key. Regenerating the {% data variables.product.pat_generic %} will not delete the deploy key. +* If the deploy key is created with an {% data variables.product.prodname_oauth_app %} token, revoking the token will also delete the deploy key. Conversely, these activities will not delete a deploy key: -- If the deploy key is created with a {% data variables.product.prodname_github_app %} user access token, revoking the token will not delete the deploy key. -- If the deploy key is created with a {% data variables.product.prodname_github_app %} installation access token, uninstalling or deleting the app will not delete the deploy key. -- If the deploy key is created with a {% data variables.product.pat_generic %}, regenerating the {% data variables.product.pat_generic %} will not delete the deploy key. +* If the deploy key is created with a {% data variables.product.prodname_github_app %} user access token, revoking the token will not delete the deploy key. +* If the deploy key is created with a {% data variables.product.prodname_github_app %} installation access token, uninstalling or deleting the app will not delete the deploy key. +* If the deploy key is created with a {% data variables.product.pat_generic %}, regenerating the {% data variables.product.pat_generic %} will not delete the deploy key. diff --git a/content/rest/enterprise-admin/scim.md b/content/rest/enterprise-admin/scim.md index d03ccacb8076..d3f62dbc6bd2 100644 --- a/content/rest/enterprise-admin/scim.md +++ b/content/rest/enterprise-admin/scim.md @@ -16,9 +16,9 @@ autogenerated: rest **Notes**: -- {% data reusables.scim.ghec-open-scim-operation-differentiation %} -- {% data reusables.scim.ghec-open-scim-release-phase %} -- {% data reusables.scim.ghec-open-scim-test-in-isolation %} +* {% data reusables.scim.ghec-open-scim-operation-differentiation %} +* {% data reusables.scim.ghec-open-scim-release-phase %} +* {% data reusables.scim.ghec-open-scim-test-in-isolation %} {% endnote %} {% endif %} diff --git a/content/rest/guides/building-a-ci-server.md b/content/rest/guides/building-a-ci-server.md index acba5886a8c1..c5cb1a960ef1 100644 --- a/content/rest/guides/building-a-ci-server.md +++ b/content/rest/guides/building-a-ci-server.md @@ -21,8 +21,8 @@ in a {% data variables.product.product_name %} pull request. For more informatio This guide will use that API to demonstrate a setup that you can use. In our scenario, we will: -- Run our CI suite when a Pull Request is opened (we'll set the CI status to pending). -- When the CI is finished, we'll set the Pull Request's status accordingly. +* Run our CI suite when a Pull Request is opened (we'll set the CI status to pending). +* When the CI is finished, we'll set the Pull Request's status accordingly. Our CI system and host server will be figments of our imagination. They could be Travis, Jenkins, or something else entirely. The crux of this guide will be setting up @@ -72,8 +72,8 @@ After that, you'll create a new webhook in your repository, feeding it the URL t Click **Update webhook**. You should see a body response of `Well, it worked!`. Great! Click on **Let me select individual events**, and select the following: -- Status -- Pull Request +* Status +* Pull Request These are the events {% data variables.product.product_name %} will send to our server whenever the relevant action occurs. Let's update our server to _just_ handle the Pull Request scenario right now: @@ -140,9 +140,9 @@ end We're doing three very basic things here: -- we're looking up the full name of the repository -- we're looking up the last SHA of the pull request -- we're setting the status to "pending" +* we're looking up the full name of the repository +* we're looking up the last SHA of the pull request +* we're setting the status to "pending" That's it! From here, you can run whatever process you need to in order to execute your test suite. Maybe you're going to pass off your code to Jenkins, or call @@ -164,9 +164,9 @@ At GitHub, we've used a version of [Janky](https://github.com/github/janky) to m The basic flow is essentially the exact same as the server we've built above. At GitHub, we: -- Fire to Jenkins when a pull request is created or updated (via Janky) -- Wait for a response on the state of the CI -- If the code is green, we merge the pull request +* Fire to Jenkins when a pull request is created or updated (via Janky) +* Wait for a response on the state of the CI +* If the code is green, we merge the pull request All of this communication is funneled back to our chat rooms. You don't need to build your own CI setup to use this example. diff --git a/content/rest/guides/delivering-deployments.md b/content/rest/guides/delivering-deployments.md index ff0f48020fbe..63bdba5716b3 100644 --- a/content/rest/guides/delivering-deployments.md +++ b/content/rest/guides/delivering-deployments.md @@ -20,9 +20,9 @@ You can use the REST API to deploy your projects hosted on {% data variables.pro This guide will use the REST API to demonstrate a setup that you can use. In our scenario, we will: -- Merge a pull request. -- When the CI is finished, we'll set the pull request's status accordingly. -- When the pull request is merged, we'll run our deployment to our server. +* Merge a pull request. +* When the CI is finished, we'll set the pull request's status accordingly. +* When the pull request is merged, we'll run our deployment to our server. Our CI system and host server will be figments of our imagination. They could be Heroku, Amazon, or something else entirely. The crux of this guide will be setting up @@ -73,9 +73,9 @@ After that, you'll create a new webhook in your repository, feeding it the URL t Click **Update webhook**. You should see a body response of `Well, it worked!`. Great! Click on **Let me select individual events.**, and select the following: -- Deployment -- Deployment status -- Pull Request +* Deployment +* Deployment status +* Pull Request These are the events {% data variables.product.product_name %} will send to our server whenever the relevant action occurs. We'll configure our server to _just_ handle when pull requests are merged @@ -180,10 +180,10 @@ At GitHub, we've used a version of [Heaven](https://github.com/atmos/heaven) to our deployments for years. A common flow is essentially the same as the server we've built above: -- Wait for a response on the state of the CI checks (success or failure) -- If the required checks succeed, merge the pull request -- Heaven takes the merged code, and deploys it to staging and production servers -- In the meantime, Heaven also notifies everyone about the build, via [Hubot](https://github.com/github/hubot) sitting in our chat rooms +* Wait for a response on the state of the CI checks (success or failure) +* If the required checks succeed, merge the pull request +* Heaven takes the merged code, and deploys it to staging and production servers +* In the meantime, Heaven also notifies everyone about the build, via [Hubot](https://github.com/github/hubot) sitting in our chat rooms That's it! You don't need to build your own deployment setup to use this example. You can always rely on [GitHub integrations](https://github.com/integrations). diff --git a/content/rest/guides/scripting-with-the-rest-api-and-javascript.md b/content/rest/guides/scripting-with-the-rest-api-and-javascript.md index a34696828aa7..a52cf5ae3de9 100644 --- a/content/rest/guides/scripting-with-the-rest-api-and-javascript.md +++ b/content/rest/guides/scripting-with-the-rest-api-and-javascript.md @@ -428,5 +428,5 @@ await commentIfDataFilesChanged({owner: "github", repo: "docs", pullNumber: 191} ## Next steps -- To learn more about Octokit.js see [the Octokit.js documentation](https://github.com/octokit/octokit.js/#readme). -- For some real life examples, look at how {% data variables.product.company_short %} Docs uses Octokit.js by [searching the {% data variables.product.company_short %} Docs repository](https://github.com/search?q=repo%3Agithub%2Fdocs%20path%3A.github%20octokit&type=code). +* To learn more about Octokit.js see [the Octokit.js documentation](https://github.com/octokit/octokit.js/#readme). +* For some real life examples, look at how {% data variables.product.company_short %} Docs uses Octokit.js by [searching the {% data variables.product.company_short %} Docs repository](https://github.com/search?q=repo%3Agithub%2Fdocs%20path%3A.github%20octokit&type=code). diff --git a/content/rest/guides/scripting-with-the-rest-api-and-ruby.md b/content/rest/guides/scripting-with-the-rest-api-and-ruby.md index bb3b7bcc8a25..0b94fee3224b 100644 --- a/content/rest/guides/scripting-with-the-rest-api-and-ruby.md +++ b/content/rest/guides/scripting-with-the-rest-api-and-ruby.md @@ -329,5 +329,5 @@ puts "A comment was added to the pull request: #{comment_url}" To learn more about working with the {% data variables.product.company_short %} REST API and Octokit.rb, explore the following resources: -- To learn more about Octokit.rb see [the Octokit.rb documentation](https://github.com/octokit/octokit.rb/#readme). -- To find detailed information about {% data variables.product.company_short %}'s available REST API endpoints, including their request and response structures, see the [AUTOTITLE](/rest). +* To learn more about Octokit.rb see [the Octokit.rb documentation](https://github.com/octokit/octokit.rb/#readme). +* To find detailed information about {% data variables.product.company_short %}'s available REST API endpoints, including their request and response structures, see the [AUTOTITLE](/rest). diff --git a/content/rest/guides/using-the-rest-api-to-interact-with-checks.md b/content/rest/guides/using-the-rest-api-to-interact-with-checks.md index eb5a857788d9..ab86213f4685 100644 --- a/content/rest/guides/using-the-rest-api-to-interact-with-checks.md +++ b/content/rest/guides/using-the-rest-api-to-interact-with-checks.md @@ -27,15 +27,15 @@ When someone pushes code to a repository, GitHub creates a check suite for the l The `status` can be `queued`, `in_progress`, `requested`, `waiting`, `pending`, or `completed`. Only {% data variables.product.prodname_actions %} can set a status of `requested`, `waiting`, or `pending`. If the status is `completed`, the conclusion can be any of the following: -- `action_required` -- `cancelled` -- `timed_out` -- `failure` -- `neutral` -- `skipped` -- `stale` -- `startup_failure` -- `success` +* `action_required` +* `cancelled` +* `timed_out` +* `failure` +* `neutral` +* `skipped` +* `stale` +* `startup_failure` +* `success` The check suite reports the highest priority check run `conclusion` in the check suite's `conclusion`. For example, if three check runs have conclusions of `timed_out`, `success`, and `neutral` the check suite conclusion will be `timed_out`. @@ -56,13 +56,13 @@ A check run is an individual test that is part of a check suite. Each run includ The `status` can be `queued`, `in_progress`, `requested`, `waiting`, `pending`, or `completed`. Only {% data variables.product.prodname_actions %} can set a status of `requested`, `waiting`, or `pending`. If the status is `completed`, the conclusion can be any of the following: -- `action_required` -- `cancelled` -- `timed_out` -- `failure` -- `neutral` -- `skipped` -- `success` +* `action_required` +* `cancelled` +* `timed_out` +* `failure` +* `neutral` +* `skipped` +* `success` If a check run is in an incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/checks#create-a-check-run--parameters). diff --git a/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md b/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md index 15153cacef53..00e27914f477 100644 --- a/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md +++ b/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md @@ -26,13 +26,13 @@ the Pro Git book. As an example, if you wanted to commit a change to a file in your repository, you would: -- Get the current commit object -- Retrieve the tree it points to -- Retrieve the content of the blob object that tree has for that particular file path -- Change the content somehow and post a new blob object with that new content, getting a blob SHA back -- Post a new tree object with that file path pointer replaced with your new blob SHA getting a tree SHA back -- Create a new commit object with the current commit SHA as the parent and the new tree SHA, getting a commit SHA back -- Update the reference of your branch to point to the new commit SHA +* Get the current commit object +* Retrieve the tree it points to +* Retrieve the content of the blob object that tree has for that particular file path +* Change the content somehow and post a new blob object with that new content, getting a blob SHA back +* Post a new tree object with that file path pointer replaced with your new blob SHA getting a tree SHA back +* Create a new commit object with the current commit SHA as the parent and the new tree SHA, getting a commit SHA back +* Update the reference of your branch to point to the new commit SHA It might seem complex, but it's actually pretty simple when you understand the model and it opens up a ton of things you could potentially do with the API. diff --git a/content/rest/interactions/orgs.md b/content/rest/interactions/orgs.md index 661d2059cfea..f2983073a1ba 100644 --- a/content/rest/interactions/orgs.md +++ b/content/rest/interactions/orgs.md @@ -17,9 +17,9 @@ autogenerated: rest Organization owners can temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: -- {% data reusables.interactions.existing-user-limit-definition %} in the organization. -- {% data reusables.interactions.contributor-user-limit-definition %} in the organization. -- {% data reusables.interactions.collaborator-user-limit-definition %} in the organization. +* {% data reusables.interactions.existing-user-limit-definition %} in the organization. +* {% data reusables.interactions.contributor-user-limit-definition %} in the organization. +* {% data reusables.interactions.collaborator-user-limit-definition %} in the organization. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. To set different interaction limits for individual repositories owned by the organization, use the [Repository](/rest/interactions/repos) interactions endpoints instead. diff --git a/content/rest/interactions/repos.md b/content/rest/interactions/repos.md index d2733e1edef6..6a1d7a3fc6d2 100644 --- a/content/rest/interactions/repos.md +++ b/content/rest/interactions/repos.md @@ -20,9 +20,9 @@ autogenerated: rest People with owner or admin access can use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: -- {% data reusables.interactions.existing-user-limit-definition %} in the repository. -- {% data reusables.interactions.contributor-user-limit-definition %} in the repository. -- {% data reusables.interactions.collaborator-user-limit-definition %} in the repository. +* {% data reusables.interactions.existing-user-limit-definition %} in the repository. +* {% data reusables.interactions.contributor-user-limit-definition %} in the repository. +* {% data reusables.interactions.collaborator-user-limit-definition %} in the repository. If an interaction limit is enabled for the user or organization that owns the repository, the limit cannot be changed for the individual repository. Instead, use the [User](/rest/interactions/user) or [Organization](/rest/interactions/orgs) interactions endpoints to change the interaction limit. diff --git a/content/rest/interactions/user.md b/content/rest/interactions/user.md index 5be0ba13052f..fb2ff54290ac 100644 --- a/content/rest/interactions/user.md +++ b/content/rest/interactions/user.md @@ -17,9 +17,9 @@ autogenerated: rest You can use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: -- {% data reusables.interactions.existing-user-limit-definition %} from interacting with your repositories. -- {% data reusables.interactions.contributor-user-limit-definition %} from interacting with your repositories. -- {% data reusables.interactions.collaborator-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.existing-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.contributor-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.collaborator-user-limit-definition %} from interacting with your repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. To set different interaction limits for individual repositories owned by the user, use the [Repository](/rest/interactions/repos) interactions endpoints instead. diff --git a/content/rest/licenses/licenses.md b/content/rest/licenses/licenses.md index 25af010d4e2e..2c4b0a0149e0 100644 --- a/content/rest/licenses/licenses.md +++ b/content/rest/licenses/licenses.md @@ -24,12 +24,12 @@ If a license is matched, the license key and name returned conforms to the [SPDX **Note:** These endpoints will also return a repository's license information: -- [Get a repository](/rest/repos/repos#get-a-repository) -- [List repositories for a user](/rest/repos/repos#list-repositories-for-a-user) -- [List organization repositories](/rest/repos/repos#list-organization-repositories) -- [List forks](/rest/repos/forks#list-forks) -- [List repositories watched by a user](/rest/activity/watching#list-repositories-watched-by-a-user) -- [List team repositories](/rest/teams/teams#list-team-repositories) +* [Get a repository](/rest/repos/repos#get-a-repository) +* [List repositories for a user](/rest/repos/repos#list-repositories-for-a-user) +* [List organization repositories](/rest/repos/repos#list-organization-repositories) +* [List forks](/rest/repos/forks#list-forks) +* [List repositories watched by a user](/rest/activity/watching#list-repositories-watched-by-a-user) +* [List team repositories](/rest/teams/teams#list-team-repositories) {% warning %} diff --git a/content/rest/metrics/statistics.md b/content/rest/metrics/statistics.md index 6eca167b7cda..e6066c4de7a2 100644 --- a/content/rest/metrics/statistics.md +++ b/content/rest/metrics/statistics.md @@ -34,7 +34,7 @@ Repository statistics are cached by the SHA of the repository's default branch; The statistics exposed by the API match the statistics shown by [different repository graphs](/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs). To summarize this: -- All statistics exclude merge commits. -- Contributor statistics also exclude empty commits. +* All statistics exclude merge commits. +* Contributor statistics also exclude empty commits. diff --git a/content/rest/packages/packages.md b/content/rest/packages/packages.md index 85314cfadb21..b0eae15013c8 100644 --- a/content/rest/packages/packages.md +++ b/content/rest/packages/packages.md @@ -21,9 +21,9 @@ autogenerated: rest After you publish a package, you can use the REST API to manage the package in your {% data variables.product.prodname_dotcom %} repositories and organizations. For more information, see "[AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)." To use the REST API to manage {% data variables.product.prodname_registry %}, you must authenticate using a {% data variables.product.pat_v1 %}. -- To access package metadata, your token must include the `read:packages` scope. -- To delete packages and package versions, your token must include the `read:packages` and `delete:packages` scopes. -- To restore packages and package versions, your token must include the `read:packages` and `write:packages` scopes. +* To access package metadata, your token must include the `read:packages` scope. +* To delete packages and package versions, your token must include the `read:packages` and `delete:packages` scopes. +* To restore packages and package versions, your token must include the `read:packages` and `write:packages` scopes. If your package is in a registry that supports granular permissions, then your token does not need the `repo` scope to access or manage this package. If your package is in a registry that only supports repository-scoped permissions, then your token must also include the `repo` scope since your package inherits permissions from a {% data variables.product.prodname_dotcom %} repository. For a list of registries that only support repository-scoped permissions, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." diff --git a/content/rest/pulls/pulls.md b/content/rest/pulls/pulls.md index d340249cc86c..fec257fb8c89 100644 --- a/content/rest/pulls/pulls.md +++ b/content/rest/pulls/pulls.md @@ -22,13 +22,13 @@ Pull requests are a type of issue. Any actions that are available in both pull r Pull requests have these possible link relations: -- `self`: The API location of this pull request -- `html`: The HTML location of this pull request -- `issue`: The API location of this pull request's [issue](/rest/issues) -- `comments`: The API location of this pull request's [issue comments](/rest/issues/comments) -- `review_comments`: The API location of this pull request's [review comments](/rest/pulls/comments) -- `review_comment`: The [URL template](/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to construct the API location for a [review comment](/rest/pulls/comments) in this pull request's repository -- `commits`: The API location of this pull request's [commits](#list-commits-on-a-pull-request) -- `statuses`: The API location of this pull request's [commit statuses](/rest/commits#commit-statuses), which are the statuses of its `head` branch +* `self`: The API location of this pull request +* `html`: The HTML location of this pull request +* `issue`: The API location of this pull request's [issue](/rest/issues) +* `comments`: The API location of this pull request's [issue comments](/rest/issues/comments) +* `review_comments`: The API location of this pull request's [review comments](/rest/pulls/comments) +* `review_comment`: The [URL template](/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to construct the API location for a [review comment](/rest/pulls/comments) in this pull request's repository +* `commits`: The API location of this pull request's [commits](#list-commits-on-a-pull-request) +* `statuses`: The API location of this pull request's [commit statuses](/rest/commits#commit-statuses), which are the statuses of its `head` branch diff --git a/content/rest/rate-limit/rate-limit.md b/content/rest/rate-limit/rate-limit.md index 13da1e5da6db..15e6b4c8d57f 100644 --- a/content/rest/rate-limit/rate-limit.md +++ b/content/rest/rate-limit/rate-limit.md @@ -20,21 +20,21 @@ You can check your current rate limit status at any time. For more information a The REST API for searching items has a custom rate limit that is separate from the rate limit governing the other REST API endpoints. For more information, see "[AUTOTITLE](/rest/search/search)." The GraphQL API also has a custom rate limit that is separate from and calculated differently than rate limits in the REST API. For more information, see "[AUTOTITLE](/graphql/overview/resource-limitations#rate-limit)." For these reasons, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: -- The `core` object provides your rate limit status for all non-search-related resources in the REST API. +* The `core` object provides your rate limit status for all non-search-related resources in the REST API. -- The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[AUTOTITLE](/rest/search/search)." +* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[AUTOTITLE](/rest/search/search)." -- The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[AUTOTITLE](/rest/search/search#search-code)." +* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[AUTOTITLE](/rest/search/search#search-code)." -- The `graphql` object provides your rate limit status for the GraphQL API. +* The `graphql` object provides your rate limit status for the GraphQL API. -- The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." +* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." -- The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[AUTOTITLE](/rest/dependency-graph)." +* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[AUTOTITLE](/rest/dependency-graph)." -- The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." +* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." -- The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/rest/actions/self-hosted-runners)." +* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/rest/actions/self-hosted-runners)." For more information on the headers and values in the rate limit response, see "[AUTOTITLE](/rest/overview/rate-limits-for-the-rest-api)." diff --git a/content/rest/repos/lfs.md b/content/rest/repos/lfs.md index a01e22abd267..3ef285a95f26 100644 --- a/content/rest/repos/lfs.md +++ b/content/rest/repos/lfs.md @@ -27,9 +27,9 @@ If you want to use these endpoints for a repository that belongs to an organizat {% ifversion ghec %} -- If repository is owned by an organization on {% data variables.product.prodname_team %}, you must be an organization owner or billing manager. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners)". -- If repository is owned by an organization that is on {% data variables.product.prodname_ghe_cloud %} and is not owned by an enterprise account, you must be an organization owner or billing manager. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners)." -- If repository is owned by an organization that is owned by an enterprise account, you must be an enterprise owner or billing manager. For more information, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners)." +* If repository is owned by an organization on {% data variables.product.prodname_team %}, you must be an organization owner or billing manager. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners)". +* If repository is owned by an organization that is on {% data variables.product.prodname_ghe_cloud %} and is not owned by an enterprise account, you must be an organization owner or billing manager. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners)." +* If repository is owned by an organization that is owned by an enterprise account, you must be an enterprise owner or billing manager. For more information, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners)." {% endif %} diff --git a/content/rest/scim/scim.md b/content/rest/scim/scim.md index cb73d1a31ac7..6410d05ee8b0 100644 --- a/content/rest/scim/scim.md +++ b/content/rest/scim/scim.md @@ -25,8 +25,8 @@ These endpoints are used by SCIM-enabled Identity Providers (IdPs) to automate p {% note %} **Notes:** -- These endpoints are only available for individual organizations that use {% data variables.product.prodname_ghe_cloud %} with SAML SSO enabled. For more information about SCIM, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." For more information about authorizing a token for a SAML SSO organization, see "[AUTOTITLE](/rest/overview/authenticating-to-the-rest-api)." -- These endpoints cannot be used with an enterprise account or with an {% data variables.enterprise.prodname_emu_org %}. +* These endpoints are only available for individual organizations that use {% data variables.product.prodname_ghe_cloud %} with SAML SSO enabled. For more information about SCIM, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." For more information about authorizing a token for a SAML SSO organization, see "[AUTOTITLE](/rest/overview/authenticating-to-the-rest-api)." +* These endpoints cannot be used with an enterprise account or with an {% data variables.enterprise.prodname_emu_org %}. {% endnote %} diff --git a/content/rest/search/search.md b/content/rest/search/search.md index f64b2644946d..7dec20ed1caf 100644 --- a/content/rest/search/search.md +++ b/content/rest/search/search.md @@ -68,8 +68,8 @@ quantities, dates, or to exclude results, see "[AUTOTITLE](/search-github/gettin ### Limitations on query length You cannot use queries that: -- are longer than 256 characters (not including operators or qualifiers). -- have more than five `AND`, `OR`, or `NOT` operators. +* are longer than 256 characters (not including operators or qualifiers). +* have more than five `AND`, `OR`, or `NOT` operators. These search queries will return a "Validation failed" error message. diff --git a/content/rest/secret-scanning/secret-scanning.md b/content/rest/secret-scanning/secret-scanning.md index 531657f550c4..072eaa66d406 100644 --- a/content/rest/secret-scanning/secret-scanning.md +++ b/content/rest/secret-scanning/secret-scanning.md @@ -20,8 +20,8 @@ autogenerated: rest You can use the API to: -- Enable or disable {% data variables.product.prodname_secret_scanning %} and push protection for a repository. For more information, see "[AUTOTITLE](/rest/repos/repos#update-a-repository)" and expand the "Properties of the `security_and_analysis` object" section. -- Retrieve and update {% data variables.secret-scanning.alerts %} from a repository. For further details, see the sections below. +* Enable or disable {% data variables.product.prodname_secret_scanning %} and push protection for a repository. For more information, see "[AUTOTITLE](/rest/repos/repos#update-a-repository)" and expand the "Properties of the `security_and_analysis` object" section. +* Retrieve and update {% data variables.secret-scanning.alerts %} from a repository. For further details, see the sections below. For more information about {% data variables.product.prodname_secret_scanning %}, see "[AUTOTITLE](/code-security/secret-scanning/about-secret-scanning)." diff --git a/content/rest/teams/external-groups.md b/content/rest/teams/external-groups.md index 7672763167cd..3b90eec81b61 100644 --- a/content/rest/teams/external-groups.md +++ b/content/rest/teams/external-groups.md @@ -25,8 +25,8 @@ To use these endpoints, the authenticated user must be a team maintainer or an o **Notes:** -- These endpoints are only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." -- If your organization uses team synchronization, you can use the API to manage team synchronization. For more information, see "[AUTOTITLE](/rest/teams/team-sync)." +* These endpoints are only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." +* If your organization uses team synchronization, you can use the API to manage team synchronization. For more information, see "[AUTOTITLE](/rest/teams/team-sync)." {% endnote %} {% endif %} diff --git a/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md b/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md index bbd23074d110..d068c1c971e1 100644 --- a/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md +++ b/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md @@ -45,9 +45,9 @@ If you are making a large number of `POST`, `PATCH`, `PUT`, or `DELETE` requests If you receive a rate limit error, you should stop making requests temporarily according to these guidelines: -- If the `retry-after` response header is present, you should not retry your request until after that many seconds has elapsed. -- If the `x-ratelimit-remaining` header is `0`, you should not make another request until after the time specified by the `x-ratelimit-reset` header. The `x-ratelimit-reset` header is in UTC epoch seconds. -- Otherwise, wait for at least one minute before retrying. If your request continues to fail due to a secondary rate limit, wait for an exponentially increasing amount of time between retries, and throw an error after a specific number of retries. +* If the `retry-after` response header is present, you should not retry your request until after that many seconds has elapsed. +* If the `x-ratelimit-remaining` header is `0`, you should not make another request until after the time specified by the `x-ratelimit-reset` header. The `x-ratelimit-reset` header is in UTC epoch seconds. +* Otherwise, wait for at least one minute before retrying. If your request continues to fail due to a secondary rate limit, wait for an exponentially increasing amount of time between retries, and throw an error after a specific number of retries. Continuing to make requests while you are rate limited may result in the banning of your integration. @@ -92,5 +92,5 @@ Intentionally ignoring repeated validation errors may result in the suspension o ## Further reading -- "[AUTOTITLE](/webhooks/using-webhooks/best-practices-for-using-webhooks)" -- "[AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app)" +* "[AUTOTITLE](/webhooks/using-webhooks/best-practices-for-using-webhooks)" +* "[AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app)" diff --git a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md index 4002df2c52ba..17f39b83fd26 100644 --- a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md +++ b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md @@ -26,12 +26,12 @@ This article describes how to use the {% data variables.product.prodname_dotcom This section describes the elements that make up an API request: -- [HTTP method](#http-method) -- [Path](#path) -- [Headers](#headers) -- [Media types](#media-types) -- [Authentication](#authentication) -- [Parameters](#parameters) +* [HTTP method](#http-method) +* [Path](#path) +* [Headers](#headers) +* [Media types](#media-types) +* [Authentication](#authentication) +* [Parameters](#parameters) Every request to the REST API includes an HTTP method and a path. Depending on the REST API endpoint, you might also need to specify request headers, authentication information, query parameters, or body parameters. @@ -45,11 +45,11 @@ For example, the HTTP method for the ["List repository issues" endpoint](/rest/i Where possible, the {% data variables.product.product_name %} REST API strives to use an appropriate HTTP method for each action. -- `GET`: Used for retrieving resources. -- `POST`: Used for creating resources. -- `PATCH`: Used for updating properties of resources. -- `PUT`: Used for replacing resources or collections of resources. -- `DELETE`: Used for deleting resources. +* `GET`: Used for retrieving resources. +* `POST`: Used for creating resources. +* `PATCH`: Used for updating properties of resources. +* `PUT`: Used for replacing resources or collections of resources. +* `DELETE`: Used for deleting resources. ### Path @@ -237,11 +237,11 @@ Use the {% data variables.product.prodname_cli %} `api` subcommand to make your In your request, specify the following options and values: -- **--method** followed by the HTTP method and the path of the endpoint. For more information, see "[HTTP method](#http-method)" and "[Path](#path)." -- **--header**: - - **`Accept`**: Pass the media type in an `Accept` header. To pass multiple media types in an `Accept` header, separate the media types with a comma: `Accept: application/vnd.github+json,application/vnd.github.diff`. For more information, see "[`Accept`](#accept)" and "[Media types](#media-types)." - - **`X-GitHub-Api-Version`**: Pass the API version in a `X-GitHub-Api-Version` header. For more information, see "[`X-GitHub-Api-Version`](#x-github-api-version)." -- **`-f`** or **`-F`** followed by any body parameters or query parameters in `key=value` format. Use the `-F` option to pass a parameter that is a number, Boolean, or null. Use the `-f` option to pass string parameters. +* **--method** followed by the HTTP method and the path of the endpoint. For more information, see "[HTTP method](#http-method)" and "[Path](#path)." +* **--header**: + * **`Accept`**: Pass the media type in an `Accept` header. To pass multiple media types in an `Accept` header, separate the media types with a comma: `Accept: application/vnd.github+json,application/vnd.github.diff`. For more information, see "[`Accept`](#accept)" and "[Media types](#media-types)." + * **`X-GitHub-Api-Version`**: Pass the API version in a `X-GitHub-Api-Version` header. For more information, see "[`X-GitHub-Api-Version`](#x-github-api-version)." +* **`-f`** or **`-F`** followed by any body parameters or query parameters in `key=value` format. Use the `-F` option to pass a parameter that is a number, Boolean, or null. Use the `-f` option to pass string parameters. Some endpoints use query parameters that are arrays. To send an array in the query string, use the query parameter once per array item, and append `[]` after the query parameter name. For example, to provide an array of two repository IDs, use `-f repository_ids[]=REPOSITORY_A_ID -f repository_ids[]=REPOSITORY_B_ID`. @@ -288,8 +288,8 @@ This section demonstrates how to make an authenticated request to the {% data va You must have `curl` installed on your machine. To check if `curl` is already installed, run `curl --version` on the command line. -- If the output provides information about the version of `curl`, that means `curl` is installed. -- If you get a message similar to `command not found: curl`, that means `curl` is not installed. Download and install `curl`. For more information, see [the curl download page](https://curl.se/download.html). +* If the output provides information about the version of `curl`, that means `curl` is installed. +* If you get a message similar to `command not found: curl`, that means `curl` is not installed. Download and install `curl`. For more information, see [the curl download page](https://curl.se/download.html). ### 2. Choose an endpoint for your request @@ -312,15 +312,15 @@ Use the `curl` command to make your request. For more information, see [the curl Specify the following options and values in your request: -- **`--request` or `-X`** followed by the HTTP method as the value. For more information, see "[HTTP method](#http-method)." -- **`--url`** followed by the full path as the value. The full path is a URL that includes the base URL for the GitHub REST API (`https://api.github.com`) and the path of the endpoint, like this: `{% data variables.product.rest_url %}/PATH`.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} Replace `PATH` with the path of the endpoint. For more information, see "[Path](#path)." +* **`--request` or `-X`** followed by the HTTP method as the value. For more information, see "[HTTP method](#http-method)." +* **`--url`** followed by the full path as the value. The full path is a URL that includes the base URL for the GitHub REST API (`https://api.github.com`) and the path of the endpoint, like this: `{% data variables.product.rest_url %}/PATH`.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} Replace `PATH` with the path of the endpoint. For more information, see "[Path](#path)." To use query parameters, add a `?` to the end of the path, then append your query parameter name and value in the form `parameter_name=value`. Separate multiple query parameters with `&`. If you need to send an array in the query string, use the query parameter once per array item, and append `[]` after the query parameter name. For example, to provide an array of two repository IDs, use `?repository_ids[]=REPOSITORY_A_ID&repository_ids[]=REPOSITORY_B_ID`. For more information, see "[Query parameters](#query-parameters)." For an example, see "[Example request using query parameters](#example-request-using-query-parameters-1)." -- **`--header` or `-H`**: - - **`Accept`**: Pass the media type in an `Accept` header. To pass multiple media types in an `Accept` header, separate the media types with a comma, for example: `Accept: application/vnd.github+json,application/vnd.github.diff`. For more information, see "[`Accept`](#accept)" and "[Media types](#media-types)." - - **`X-GitHub-Api-Version`**: Pass the API version in a `X-GitHub-Api-Version` header. For more information, see "[`X-GitHub-Api-Version`](#x-github-api-version)." - - **`Authorization`**: Pass your authentication token in an `Authorization` header. Note that in most cases you can use `Authorization: Bearer` or `Authorization: token` to pass a token. However, if you are passing a JSON web token (JWT), you must use `Authorization: Bearer`. For more information, see "[Authentication](#authentication)." For an example of a request that uses an `Authorization` header, see "[Example request using body parameters](#example-request-using-body-parameters-1)." -- **`--data` or `-d`** followed by any body parameters within a JSON object. If you do not need to specify any body parameters in your request, omit this option. For more information, see "[Body parameters](#body-parameters)." For an example, see "[Example request using body parameters](#example-request-using-body-parameters-1)." +* **`--header` or `-H`**: + * **`Accept`**: Pass the media type in an `Accept` header. To pass multiple media types in an `Accept` header, separate the media types with a comma, for example: `Accept: application/vnd.github+json,application/vnd.github.diff`. For more information, see "[`Accept`](#accept)" and "[Media types](#media-types)." + * **`X-GitHub-Api-Version`**: Pass the API version in a `X-GitHub-Api-Version` header. For more information, see "[`X-GitHub-Api-Version`](#x-github-api-version)." + * **`Authorization`**: Pass your authentication token in an `Authorization` header. Note that in most cases you can use `Authorization: Bearer` or `Authorization: token` to pass a token. However, if you are passing a JSON web token (JWT), you must use `Authorization: Bearer`. For more information, see "[Authentication](#authentication)." For an example of a request that uses an `Authorization` header, see "[Example request using body parameters](#example-request-using-body-parameters-1)." +* **`--data` or `-d`** followed by any body parameters within a JSON object. If you do not need to specify any body parameters in your request, omit this option. For more information, see "[Body parameters](#body-parameters)." For an example, see "[Example request using body parameters](#example-request-using-body-parameters-1)." #### Example request @@ -382,7 +382,7 @@ This section demonstrates how to make a request to the {% data variables.product You must install `octokit` to use the Octokit.js library shown in the following examples. -- Install `octokit`. For example, `npm install octokit`. For other ways to install or load `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +* Install `octokit`. For example, `npm install octokit`. For other ways to install or load `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). ### 2. Choose an endpoint for your request @@ -413,8 +413,8 @@ Create an access token to authenticate your request. You can save your token and 1. Use `octokit.request` to execute your request. - - Send the HTTP method and path as the first argument to the `request` method. For more information, see "[HTTP method](#http-method)" and "[Path](#path)." - - Specify all path, query, and body parameters in an object as the second argument to the `request` method. For more information, see "[Parameters](#parameters)." + * Send the HTTP method and path as the first argument to the `request` method. For more information, see "[HTTP method](#http-method)" and "[Path](#path)." + * Specify all path, query, and body parameters in an object as the second argument to the `request` method. For more information, see "[Parameters](#parameters)." In the following example request, the HTTP method is `POST`, the path is `/repos/{owner}/{repo}/issues`, the path parameters are `owner: "{% ifversion ghes %}REPO-OWNER{% else %}octocat{% endif %}"` and `repo: "{% ifversion ghes %}REPO-NAME{% else %}Spoon-Knife{% endif %}"`, and the body parameters are `title: "Created with the REST API"` and `body: "This is a test issue created by the REST API"`.{% ifversion ghes %} Replace `REPO-OWNER` with the name of the account that owns the repository, and `REPO-NAME` with the name of the repository.{% endif %} @@ -685,8 +685,8 @@ For more information about jq, see [the jq documentation](https://stedolan.githu A response can include all attributes for a resource or only a subset of attributes, depending on whether you fetch an individual resource or a list of resources. -- When you fetch an _individual resource_, like a specific repository, the response will typically include all attributes for that resource. This is the "detailed" representation of the resource. -- When you fetch a _list of resources_, like a list of multiple repositories, the response will only include a subset of the attributes for each resource. This is the "summary" representation of the resource. +* When you fetch an _individual resource_, like a specific repository, the response will typically include all attributes for that resource. This is the "detailed" representation of the resource. +* When you fetch a _list of resources_, like a list of multiple repositories, the response will only include a subset of the attributes for each resource. This is the "summary" representation of the resource. Note that authorization sometimes influences the amount of detail included in a representation. diff --git a/content/rest/using-the-rest-api/libraries-for-the-rest-api.md b/content/rest/using-the-rest-api/libraries-for-the-rest-api.md index 95d0ead9ae00..a49d73570724 100644 --- a/content/rest/using-the-rest-api/libraries-for-the-rest-api.md +++ b/content/rest/using-the-rest-api/libraries-for-the-rest-api.md @@ -27,10 +27,10 @@ You can use libraries to extend and simplify the way your application interacts For more information, see "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript)" and "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-ruby)." -- JavaScript: [octokit.js](https://github.com/octokit/octokit.js) -- Ruby: [octokit.rb](https://github.com/octokit/octokit.rb) -- .NET: [octokit.net](https://github.com/octokit/octokit.net) -- Terraform: [terraform-provider-github](https://github.com/integrations/terraform-provider-github) +* JavaScript: [octokit.js](https://github.com/octokit/octokit.js) +* Ruby: [octokit.rb](https://github.com/octokit/octokit.rb) +* .NET: [octokit.net](https://github.com/octokit/octokit.net) +* Terraform: [terraform-provider-github](https://github.com/integrations/terraform-provider-github) @@ -42,83 +42,83 @@ These third-party libraries are not maintained by {% data variables.product.comp ### Clojure -- Tentacles: [clj-commons/tentacles](https://github.com/clj-commons/tentacles) +* Tentacles: [clj-commons/tentacles](https://github.com/clj-commons/tentacles) ### Dart -- github.dart: [SpinlockLabs/github.dart](https://github.com/SpinlockLabs/github.dart) +* github.dart: [SpinlockLabs/github.dart](https://github.com/SpinlockLabs/github.dart) ### Emacs Lisp -- gh.el: [sigma/gh.el](https://github.com/sigma/gh.el) +* gh.el: [sigma/gh.el](https://github.com/sigma/gh.el) ### Go -- go-github: [google/go-github](https://github.com/google/go-github) +* go-github: [google/go-github](https://github.com/google/go-github) ### Haskell -- haskell-github: [haskell-github/github](https://github.com/fpco/github) +* haskell-github: [haskell-github/github](https://github.com/fpco/github) ### Java -- GitHub API for Java, an object oriented representation of the GitHub API: [org.kohsuke.github (From github-api)](http://github-api.kohsuke.org/) -- JCabi GitHub API, based on Java7 JSON API (JSR-353), simplifies tests with a runtime GitHub stub, and covers the entire API: [github.jcabi.com (Personal Website)](http://github.jcabi.com) +* GitHub API for Java, an object oriented representation of the GitHub API: [org.kohsuke.github (From github-api)](http://github-api.kohsuke.org/) +* JCabi GitHub API, based on Java7 JSON API (JSR-353), simplifies tests with a runtime GitHub stub, and covers the entire API: [github.jcabi.com (Personal Website)](http://github.jcabi.com) ### JavaScript -- NodeJS GitHub library: [pksunkara/octonode](https://github.com/pksunkara/octonode) -- Github.js wrapper around the GitHub API: [github-tools/github](https://github.com/github-tools/github) -- Promise-Based CoffeeScript library for the Browser or NodeJS: [philschatz/github-client](https://github.com/philschatz/github-client) +* NodeJS GitHub library: [pksunkara/octonode](https://github.com/pksunkara/octonode) +* Github.js wrapper around the GitHub API: [github-tools/github](https://github.com/github-tools/github) +* Promise-Based CoffeeScript library for the Browser or NodeJS: [philschatz/github-client](https://github.com/philschatz/github-client) ### Julia -- GitHub.jl: [JuliaWeb/GitHub.jl](https://github.com/JuliaWeb/GitHub.jl) +* GitHub.jl: [JuliaWeb/GitHub.jl](https://github.com/JuliaWeb/GitHub.jl) ### OCaml -- ocaml-github: [mirage/ocaml-github](https://github.com/mirage/ocaml-github) +* ocaml-github: [mirage/ocaml-github](https://github.com/mirage/ocaml-github) ### Perl -- Pithub: [plu/Pithub](https://github.com/plu/Pithub) -- Net::GitHub: [fayland/perl-net-github](https://github.com/fayland/perl-net-github) +* Pithub: [plu/Pithub](https://github.com/plu/Pithub) +* Net::GitHub: [fayland/perl-net-github](https://github.com/fayland/perl-net-github) ### PHP -- PHP GitHub API: [KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api) -- GitHub Joomla! Package: [joomla-framework/github-api](https://github.com/joomla-framework/github-api) -- GitHub bridge for Laravel: [GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) +* PHP GitHub API: [KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api) +* GitHub Joomla! Package: [joomla-framework/github-api](https://github.com/joomla-framework/github-api) +* GitHub bridge for Laravel: [GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) ### PowerShell -- PowerShellForGitHub: [microsoft/PowerShellForGitHub](https://github.com/microsoft/PowerShellForGitHub) +* PowerShellForGitHub: [microsoft/PowerShellForGitHub](https://github.com/microsoft/PowerShellForGitHub) ### Python -- gidgethub: [gidgethub/gidgethub](https://github.com/gidgethub/gidgethub) -- ghapi: [fastai/ghapi](https://github.com/fastai/ghapi) -- PyGithub: [PyGithub/PyGithub](https://github.com/PyGithub/PyGithub) -- libsaas: [duckboard/libsaas](https://github.com/ducksboard/libsaas) -- github3.py: [sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py) -- agithub: [mozilla/agithub](https://github.com/mozilla/agithub) -- github-flask: [github-flask (Official Website)](http://github-flask.readthedocs.org) -- githubkit: [yanyongyu/githubkit](https://github.com/yanyongyu/githubkit) -- octokit.py: [khornberg/octokit.py](https://github.com/khornberg/octokit.py) +* gidgethub: [gidgethub/gidgethub](https://github.com/gidgethub/gidgethub) +* ghapi: [fastai/ghapi](https://github.com/fastai/ghapi) +* PyGithub: [PyGithub/PyGithub](https://github.com/PyGithub/PyGithub) +* libsaas: [duckboard/libsaas](https://github.com/ducksboard/libsaas) +* github3.py: [sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py) +* agithub: [mozilla/agithub](https://github.com/mozilla/agithub) +* github-flask: [github-flask (Official Website)](http://github-flask.readthedocs.org) +* githubkit: [yanyongyu/githubkit](https://github.com/yanyongyu/githubkit) +* octokit.py: [khornberg/octokit.py](https://github.com/khornberg/octokit.py) ### Ruby -- GitHub API Gem: [piotrmurach/github](https://github.com/piotrmurach/github) +* GitHub API Gem: [piotrmurach/github](https://github.com/piotrmurach/github) ### Rust -- Octocrab: [XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab) -- Octocat: [octocat-rs/octocat-rs](https://github.com/octocat-rs/octocat-rs) +* Octocrab: [XAMPPRocky/octocrab](https://github.com/XAMPPRocky/octocrab) +* Octocat: [octocat-rs/octocat-rs](https://github.com/octocat-rs/octocat-rs) ### Scala -- Github4s: [47deg/github4s](https://github.com/47deg/github4s) +* Github4s: [47deg/github4s](https://github.com/47deg/github4s) ### Shell -- ok.sh: [whiteinge/ok.sh](https://github.com/whiteinge/ok.sh) +* ok.sh: [whiteinge/ok.sh](https://github.com/whiteinge/ok.sh) diff --git a/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md b/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md index 5ec56f80c393..ab64e8e8ad6b 100644 --- a/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md +++ b/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md @@ -22,9 +22,9 @@ If you exceed your primary rate limit, you will receive a `403 Forbidden` or `42 If you receive a rate limit error, you should stop making requests temporarily according to these guidelines: -- If the `retry-after` response header is present, you should not retry your request until after that many seconds has elapsed. -- If the `x-ratelimit-remaining` header is `0`, you should not make another request until after the time specified by the `x-ratelimit-reset` header. The `x-ratelimit-reset` header is in UTC epoch seconds. -- Otherwise, wait for at least one minute before retrying. If your request continues to fail due to a secondary rate limit, wait for an exponentially increasing amount of time between retries, and throw an error after a specific number of retries. +* If the `retry-after` response header is present, you should not retry your request until after that many seconds has elapsed. +* If the `x-ratelimit-remaining` header is `0`, you should not make another request until after the time specified by the `x-ratelimit-reset` header. The `x-ratelimit-reset` header is in UTC epoch seconds. +* Otherwise, wait for at least one minute before retrying. If your request continues to fail due to a secondary rate limit, wait for an exponentially increasing amount of time between retries, and throw an error after a specific number of retries. Continuing to make requests while you are rate limited may result in the banning of your integration. @@ -36,34 +36,34 @@ If you make a request to access a private resource and your request isn't proper If you get a `404 Not Found` response when you know that the resource that you are requesting exists, you should check your authentication. For example: -- If you are using a {% data variables.product.pat_v1 %}, you should ensure that: - - The token has the scopes that are required to use the endpoint. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes)" and "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)." - - The owner of the token has any permissions that are required to use the endpoint. For example, if an endpoint can only be used by organization owners, only users that are owners of the affected organization can use the endpoint. - - The token has not been expired or revoked. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation)."{% ifversion pat-v2 %} -- If you are using a {% data variables.product.pat_v2 %}, you should ensure that: - - The token has the permissions that are required to use the endpoint. For more information about the required permissions, see the documentation for the endpoint. - - The resource owner that was specified for the token matches the owner of the resource that the endpoint will affect. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)." - - The token has access to any private repositories that the endpoint will affect. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)." - - The owner of the token has any permissions that are required to use the endpoint. For example, if an endpoint can only be used by organization owners, only users that are owners of the affected organization can use the endpoint. - - The token has not been expired or revoked. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation)."{% endif %} -- If you are using a {% data variables.product.prodname_github_app %} installation access token, you should ensure that: - - The {% data variables.product.prodname_github_app %} has the permissions that are required to use the endpoint. For more information about the required permissions, see the documentation for the endpoint. - - The endpoint is only affecting resources owned by the account where the {% data variables.product.prodname_github_app %} is installed. - - The {% data variables.product.prodname_github_app %} has access to any repositories that the endpoint will affect. - - The token has not been expired or revoked. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation)." -- If you are using a {% data variables.product.prodname_github_app %} user access token, you should ensure that: - - The {% data variables.product.prodname_github_app %} has the permissions that are required to use the endpoint. For more information about the required permissions, see the documentation for the endpoint. - - The user that authorized the token has any permissions that are required to use the endpoint. For example, if an endpoint can only be used by organization owners, only users that are owners of the affected organization can use the endpoint. - - The {% data variables.product.prodname_github_app %} has access to any repositories that the endpoint will affect. - - The user has access to any repositories that the endpoint will affect. - - The user has approved any updated permissions for your {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/using-github-apps/approving-updated-permissions-for-a-github-app)." -- If you are using an {% data variables.product.prodname_oauth_app %} user access token, you should ensure that: - - The token has the scopes that are required to use the endpoint. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes)." - - The user that authorized the token has any permissions that are required to use the endpoint. For example, if an endpoint can only be used by organization owners, only users that are owners of the affected organization can use the endpoint. - - The organization has not blocked OAuth app access, if you are using an endpoint that will affect resources owned by an organization. App owners cannot see whether their app is blocked, but they can instruct users of the app to check this. For more information, see {% ifversion fpt or ghec%}"[AUTOTITLE](/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions)."{% else %}"[AUTOTITLE](/free-pro-team@latest/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions)" in the {% data variables.product.prodname_free_team %} documentation.{% endif %} - - The token has not been expired or revoked. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation)." -- If you are using `GITHUB_TOKEN` in a {% data variables.product.prodname_actions %} workflow, you should ensure that: - - The endpoint is only affecting resources owned by the repository where the workflow is running. If you need to access resources outside of that repository, such as resources owned by an organization or resources owned by another repository, you should use a {% data variables.product.pat_generic %} or an access token for a {% data variables.product.prodname_github_app %}. +* If you are using a {% data variables.product.pat_v1 %}, you should ensure that: + * The token has the scopes that are required to use the endpoint. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes)" and "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)." + * The owner of the token has any permissions that are required to use the endpoint. For example, if an endpoint can only be used by organization owners, only users that are owners of the affected organization can use the endpoint. + * The token has not been expired or revoked. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation)."{% ifversion pat-v2 %} +* If you are using a {% data variables.product.pat_v2 %}, you should ensure that: + * The token has the permissions that are required to use the endpoint. For more information about the required permissions, see the documentation for the endpoint. + * The resource owner that was specified for the token matches the owner of the resource that the endpoint will affect. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)." + * The token has access to any private repositories that the endpoint will affect. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)." + * The owner of the token has any permissions that are required to use the endpoint. For example, if an endpoint can only be used by organization owners, only users that are owners of the affected organization can use the endpoint. + * The token has not been expired or revoked. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation)."{% endif %} +* If you are using a {% data variables.product.prodname_github_app %} installation access token, you should ensure that: + * The {% data variables.product.prodname_github_app %} has the permissions that are required to use the endpoint. For more information about the required permissions, see the documentation for the endpoint. + * The endpoint is only affecting resources owned by the account where the {% data variables.product.prodname_github_app %} is installed. + * The {% data variables.product.prodname_github_app %} has access to any repositories that the endpoint will affect. + * The token has not been expired or revoked. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation)." +* If you are using a {% data variables.product.prodname_github_app %} user access token, you should ensure that: + * The {% data variables.product.prodname_github_app %} has the permissions that are required to use the endpoint. For more information about the required permissions, see the documentation for the endpoint. + * The user that authorized the token has any permissions that are required to use the endpoint. For example, if an endpoint can only be used by organization owners, only users that are owners of the affected organization can use the endpoint. + * The {% data variables.product.prodname_github_app %} has access to any repositories that the endpoint will affect. + * The user has access to any repositories that the endpoint will affect. + * The user has approved any updated permissions for your {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/using-github-apps/approving-updated-permissions-for-a-github-app)." +* If you are using an {% data variables.product.prodname_oauth_app %} user access token, you should ensure that: + * The token has the scopes that are required to use the endpoint. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes)." + * The user that authorized the token has any permissions that are required to use the endpoint. For example, if an endpoint can only be used by organization owners, only users that are owners of the affected organization can use the endpoint. + * The organization has not blocked OAuth app access, if you are using an endpoint that will affect resources owned by an organization. App owners cannot see whether their app is blocked, but they can instruct users of the app to check this. For more information, see {% ifversion fpt or ghec%}"[AUTOTITLE](/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions)."{% else %}"[AUTOTITLE](/free-pro-team@latest/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions)" in the {% data variables.product.prodname_free_team %} documentation.{% endif %} + * The token has not been expired or revoked. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation)." +* If you are using `GITHUB_TOKEN` in a {% data variables.product.prodname_actions %} workflow, you should ensure that: + * The endpoint is only affecting resources owned by the repository where the workflow is running. If you need to access resources outside of that repository, such as resources owned by an organization or resources owned by another repository, you should use a {% data variables.product.pat_generic %} or an access token for a {% data variables.product.prodname_github_app %}. For more information about authentication, see "[AUTOTITLE](/rest/overview/authenticating-to-the-rest-api)." @@ -105,9 +105,9 @@ The value of the `X-Accepted-GitHub-Permissions` header is a comma separated lis For example: -- `X-Accepted-GitHub-Permissions: contents=read` means that your {% data variables.product.prodname_github_app %}{% ifversion pat-v2 %} or {% data variables.product.pat_v2 %}{% endif %} needs read access to the contents permission. -- `X-Accepted-GitHub-Permissions: pull_requests=write,contents=read` means that your {% data variables.product.prodname_github_app %}{% ifversion pat-v2 %} or {% data variables.product.pat_v2 %}{% endif %} needs write access to the pull request permission and read access to the contents permission. -- `X-Accepted-GitHub-Permissions: pull_requests=read,contents=read; issues=read,contents=read` means that your {% data variables.product.prodname_github_app %}{% ifversion pat-v2 %} or {% data variables.product.pat_v2 %}{% endif %} needs either read access to the pull request permission and read access to the contents permission, or read access to the issues permission and read access to the contents permission. +* `X-Accepted-GitHub-Permissions: contents=read` means that your {% data variables.product.prodname_github_app %}{% ifversion pat-v2 %} or {% data variables.product.pat_v2 %}{% endif %} needs read access to the contents permission. +* `X-Accepted-GitHub-Permissions: pull_requests=write,contents=read` means that your {% data variables.product.prodname_github_app %}{% ifversion pat-v2 %} or {% data variables.product.pat_v2 %}{% endif %} needs write access to the pull request permission and read access to the contents permission. +* `X-Accepted-GitHub-Permissions: pull_requests=read,contents=read; issues=read,contents=read` means that your {% data variables.product.prodname_github_app %}{% ifversion pat-v2 %} or {% data variables.product.pat_v2 %}{% endif %} needs either read access to the pull request permission and read access to the contents permission, or read access to the issues permission and read access to the contents permission. {% endif %} @@ -162,6 +162,6 @@ If you observe unexpected failures, you can use [githubstatus.com](https://www.g ## Further reading -- "[AUTOTITLE](/rest/guides/best-practices-for-using-the-rest-api)" -- "[AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks)" -- "[AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app)" +* "[AUTOTITLE](/rest/guides/best-practices-for-using-the-rest-api)" +* "[AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks)" +* "[AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app)" diff --git a/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md b/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md index c304fd7fac06..55780cf8feb9 100644 --- a/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md +++ b/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md @@ -45,10 +45,10 @@ link: ; rel="prev", < The `link` header provides the URL for the previous, next, first, and last page of results: -- The URL for the previous page is followed by `rel="prev"`. -- The URL for the next page is followed by `rel="next"`. -- The URL for the last page is followed by `rel="last"`. -- The URL for the first page is followed by `rel="first"`. +* The URL for the previous page is followed by `rel="prev"`. +* The URL for the next page is followed by `rel="next"`. +* The URL for the last page is followed by `rel="last"`. +* The URL for the first page is followed by `rel="first"`. In some cases, only a subset of these links are available. For example, the link to the previous page won't be included if you are on the first page of results, and the link to the last page won't be included if it can't be calculated. diff --git a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md index 72bcb69cdfef..97f14aef84e8 100644 --- a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md +++ b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md @@ -22,14 +22,14 @@ topics: {% data reusables.search.you-can-search-globally %} -- To search globally across all of {% data variables.product.product_name %}, type what you're looking for into the search field at the top of any page, and choose "Search all of {% data variables.product.prodname_dotcom %}" in the search dropdown menu. -- To search within a particular repository or organization, navigate to the repository or organization page, type what you're looking for into the search field at the top of the page, and press **Enter**. +* To search globally across all of {% data variables.product.product_name %}, type what you're looking for into the search field at the top of any page, and choose "Search all of {% data variables.product.prodname_dotcom %}" in the search dropdown menu. +* To search within a particular repository or organization, navigate to the repository or organization page, type what you're looking for into the search field at the top of the page, and press **Enter**. {% ifversion code-search-upgrade %}You can also use suggestions and completions in the search bar to quickly find what you need. -- If you click on the search bar in the top navigation of GitHub.com, you will see a list of suggestions organized by category, including recent searches and suggested repositories, teams, and projects that you have access to. -- Clicking on any of the specific suggestions will take you directly to the page for that suggestion (for example, the repository or project page). If you click on a recent search, depending on the type of search, the search term will appear in the search bar or you will be taken to the search results page for the search term. -- Once you start typing, you will see a list of completions and suggestions that match your query. You can click on a suggestion to jump to a specific location. As you continue to type, you will see more specific suggestions, such as code files you can jump to directly. +* If you click on the search bar in the top navigation of GitHub.com, you will see a list of suggestions organized by category, including recent searches and suggested repositories, teams, and projects that you have access to. +* Clicking on any of the specific suggestions will take you directly to the page for that suggestion (for example, the repository or project page). If you click on a recent search, depending on the type of search, the search term will appear in the search bar or you will be taken to the search results page for the search term. +* Once you start typing, you will see a list of completions and suggestions that match your query. You can click on a suggestion to jump to a specific location. As you continue to type, you will see more specific suggestions, such as code files you can jump to directly. After typing a search query, you can press **Enter** to go to the full search results view, where you can see each match and a visual interface for applying filters. For more information, see "[Searching using a visual interface](#searching-using-a-visual-interface)." {% endif %} @@ -38,10 +38,10 @@ After typing a search query, you can press **Enter** to go to the full search re **Notes:** -- {% data reusables.search.required_login %} -- {% data variables.product.prodname_pages %} sites are not searchable on {% data variables.product.product_name %}. However you can search the source content if it exists in the default branch of a repository, using code search. For more information, see "[AUTOTITLE]{% ifversion code-search-upgrade %}(/search-github/github-code-search/understanding-github-code-search-syntax){% else %}(/search-github/searching-on-github/searching-code){% endif %}." For more information about {% data variables.product.prodname_pages %}, see "[AUTOTITLE](/pages/getting-started-with-github-pages/about-github-pages)" -- Currently our search doesn't support exact matching.{% ifversion ghes %} -- Whenever you are searching in code files, only the first two results in each file will be returned.{% endif %} +* {% data reusables.search.required_login %} +* {% data variables.product.prodname_pages %} sites are not searchable on {% data variables.product.product_name %}. However you can search the source content if it exists in the default branch of a repository, using code search. For more information, see "[AUTOTITLE]{% ifversion code-search-upgrade %}(/search-github/github-code-search/understanding-github-code-search-syntax){% else %}(/search-github/searching-on-github/searching-code){% endif %}." For more information about {% data variables.product.prodname_pages %}, see "[AUTOTITLE](/pages/getting-started-with-github-pages/about-github-pages)" +* Currently our search doesn't support exact matching.{% ifversion ghes %} +* Whenever you are searching in code files, only the first two results in each file will be returned.{% endif %} {% endnote %} @@ -53,15 +53,15 @@ After running a search on {% data variables.product.product_name %}, you can sor You can search for the following information across all repositories you can access on {% data variables.location.product_location %}. -- [Repositories](/search-github/searching-on-github/searching-for-repositories) -- [Topics](/search-github/searching-on-github/searching-topics) -- [Issues and pull requests](/search-github/searching-on-github/searching-issues-and-pull-requests){% ifversion fpt or ghec %} -- [Discussions](/search-github/searching-on-github/searching-discussions){% endif %} -- {% ifversion code-search-upgrade %}[Code](/search-github/github-code-search/understanding-github-code-search-syntax){% else %}[Code](/search-github/searching-on-github/searching-code){% endif %} -- [Commits](/search-github/searching-on-github/searching-commits) -- [Users](/search-github/searching-on-github/searching-users) -- [Packages](/search-github/searching-on-github/searching-for-packages) -- [Wikis](/search-github/searching-on-github/searching-wikis) +* [Repositories](/search-github/searching-on-github/searching-for-repositories) +* [Topics](/search-github/searching-on-github/searching-topics) +* [Issues and pull requests](/search-github/searching-on-github/searching-issues-and-pull-requests){% ifversion fpt or ghec %} +* [Discussions](/search-github/searching-on-github/searching-discussions){% endif %} +* {% ifversion code-search-upgrade %}[Code](/search-github/github-code-search/understanding-github-code-search-syntax){% else %}[Code](/search-github/searching-on-github/searching-code){% endif %} +* [Commits](/search-github/searching-on-github/searching-commits) +* [Users](/search-github/searching-on-github/searching-users) +* [Packages](/search-github/searching-on-github/searching-for-packages) +* [Wikis](/search-github/searching-on-github/searching-wikis) ## Searching using a visual interface @@ -92,5 +92,5 @@ To limit your search to one environment, you can use a filter option on the {% d ## Further reading -- "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)" -- "[AUTOTITLE](/search-github/searching-on-github)" +* "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)" +* "[AUTOTITLE](/search-github/searching-on-github)" diff --git a/content/search-github/getting-started-with-searching-on-github/sorting-search-results.md b/content/search-github/getting-started-with-searching-on-github/sorting-search-results.md index c9e13d08523f..004b972690fc 100644 --- a/content/search-github/getting-started-with-searching-on-github/sorting-search-results.md +++ b/content/search-github/getting-started-with-searching-on-github/sorting-search-results.md @@ -77,5 +77,5 @@ The `sort:updated` qualifier sorts by how recently the items were updated. ## Further reading -- "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)" -- "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)" +* "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)" +* "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)" diff --git a/content/search-github/getting-started-with-searching-on-github/troubleshooting-search-queries.md b/content/search-github/getting-started-with-searching-on-github/troubleshooting-search-queries.md index a8ef06782cf3..2fc5e82756b5 100644 --- a/content/search-github/getting-started-with-searching-on-github/troubleshooting-search-queries.md +++ b/content/search-github/getting-started-with-searching-on-github/troubleshooting-search-queries.md @@ -23,11 +23,11 @@ Reaching a timeout does not necessarily mean that search results are incomplete. There are some limits to the length of the queries when searching across {% data variables.product.product_name %}: -- Queries longer than 256 characters are not supported -- You can't construct a query using more than five `AND`, `OR`, or `NOT` operators +* Queries longer than 256 characters are not supported +* You can't construct a query using more than five `AND`, `OR`, or `NOT` operators Specific search types, such as code search, might have additional limitations. Check the documentation for these search types for more information. {% ifversion code-search-upgrade %} For more information on code search limitations specifically, see "[AUTOTITLE](/search-github/github-code-search/about-github-code-search#limitations)."{% endif %} ## Further reading -- "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)" +* "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)" diff --git a/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md b/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md index 9fa2ea607206..9788eb1f3ce3 100644 --- a/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md +++ b/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md @@ -91,8 +91,8 @@ Query | Example If your search query contains whitespace, you will need to surround it with quotation marks. For example: -- [cats NOT "hello world"](https://github.com/search?utf8=✓&q=cats+NOT+"hello+world"&type=Repositories) matches repositories with the word "cats" but not the words "hello world." -- [build label:"bug fix"](https://github.com/search?utf8=%E2%9C%93&q=build+label%3A%22bug+fix%22&type=Issues) matches issues with the word "build" that have the label "bug fix." +* [cats NOT "hello world"](https://github.com/search?utf8=✓&q=cats+NOT+"hello+world"&type=Repositories) matches repositories with the word "cats" but not the words "hello world." +* [build label:"bug fix"](https://github.com/search?utf8=%E2%9C%93&q=build+label%3A%22bug+fix%22&type=Issues) matches issues with the word "build" that have the label "bug fix." {% ifversion ghes %} Some non-alphanumeric symbols, such as spaces, are dropped from code search queries within quotation marks, so results can be unexpected.{% endif %} diff --git a/content/search-github/github-code-search/about-github-code-search.md b/content/search-github/github-code-search/about-github-code-search.md index b673f43569a6..7cc94c5d8e54 100644 --- a/content/search-github/github-code-search/about-github-code-search.md +++ b/content/search-github/github-code-search/about-github-code-search.md @@ -32,14 +32,14 @@ We have indexed many public repositories for code search, and continue to index The current limitations on indexed code are: -- Vendored and generated code is excluded -- Empty files and files over 350 KiB are excluded -- Lines over 1,024 characters long are truncated -- Binary files (PDF, etc.) are excluded -- Only UTF-8 encoded files are included -- Very large repositories may not be indexed -- Exhaustive search is not supported -- Files with more than one line over 4096 bytes are excluded +* Vendored and generated code is excluded +* Empty files and files over 350 KiB are excluded +* Lines over 1,024 characters long are truncated +* Binary files (PDF, etc.) are excluded +* Only UTF-8 encoded files are included +* Very large repositories may not be indexed +* Exhaustive search is not supported +* Files with more than one line over 4096 bytes are excluded We currently only support searching for code on the default branch of a repository. The query length is limited to 1000 characters. diff --git a/content/search-github/github-code-search/understanding-github-code-search-syntax.md b/content/search-github/github-code-search/understanding-github-code-search-syntax.md index 886e15be142e..2f36a085a63c 100644 --- a/content/search-github/github-code-search/understanding-github-code-search-syntax.md +++ b/content/search-github/github-code-search/understanding-github-code-search-syntax.md @@ -98,13 +98,13 @@ You can use parentheses to express more complicated boolean expressions. For exa ## Using qualifiers You can use specialized keywords to qualify your search. -- [Repository qualifier](#repository-qualifier) -- [Organization and user qualifiers](#organization-and-user-qualifiers) -- [Language qualifier](#language-qualifier) -- [Path qualifier](#path-qualifier) -- [Symbol qualifier](#symbol-qualifier) -- [Content qualifier](#content-qualifier) -- [Is qualifier](#is-qualifier) +* [Repository qualifier](#repository-qualifier) +* [Organization and user qualifiers](#organization-and-user-qualifiers) +* [Language qualifier](#language-qualifier) +* [Path qualifier](#path-qualifier) +* [Symbol qualifier](#symbol-qualifier) +* [Content qualifier](#content-qualifier) +* [Is qualifier](#is-qualifier) ### Repository qualifier @@ -191,13 +191,13 @@ To search for JavaScript files within a `src` directory, you could use: path:src/*.js ``` -- By default, glob expressions are not anchored to the start of the path, so the above expression would still match a path like `app/src/main.js`. But if you prefix the expression with `/`, it will anchor to the start. For example: +* By default, glob expressions are not anchored to the start of the path, so the above expression would still match a path like `app/src/main.js`. But if you prefix the expression with `/`, it will anchor to the start. For example: ```text path:/src/*.js ``` -- Note that `*` doesn't match the `/` character, so for the above example, all results will be direct descendants of the `src` directory. To match within subdirectories, so that results include deeply nested files such as `/src/app/testing/utils/example.js`, you can use `**`. For example: +* Note that `*` doesn't match the `/` character, so for the above example, all results will be direct descendants of the `src` directory. To match within subdirectories, so that results include deeply nested files such as `/src/app/testing/utils/example.js`, you can use `**`. For example: ```text path:/src/**/*.js @@ -258,10 +258,10 @@ This query would only match files containing the term `README.md`, rather than m To filter based on repository properties, you can use the `is:` qualifier. `is:` supports the following values: -- `archived`: restricts the search to archived repositories. -- `fork`: restricts the search to forked repositories. -- `vendored`: restricts the search to content detected as vendored. -- `generated`: restricts the search to content detected as generated. +* `archived`: restricts the search to archived repositories. +* `fork`: restricts the search to forked repositories. +* `vendored`: restricts the search to content detected as vendored. +* `generated`: restricts the search to content detected as generated. For example: diff --git a/content/search-github/github-code-search/using-github-code-search.md b/content/search-github/github-code-search/using-github-code-search.md index 5d3d8702efef..3b53cdc8df6c 100644 --- a/content/search-github/github-code-search/using-github-code-search.md +++ b/content/search-github/github-code-search/using-github-code-search.md @@ -45,8 +45,8 @@ For more information about the search syntax of code search, see "[AUTOTITLE](/s 1. To finish creating your saved search, click **Create saved search**. 1. To see your saved search, click the search bar. Your saved search will be in the "Saved queries" section. Clicking on a saved search entry will add the query to the search bar and filter the suggestions accordingly. 1. To manage a saved search, type `saved:` in the search bar, then click {% octicon "plus-circle" aria-hidden="true" %} **Manage saved searches**. - - To edit a saved search, to the right of the search, click {% octicon "pencil" aria-label="The pencil icon" %}. - - To delete a saved search, to the right of the search, click {% octicon "trash" aria-label="The trash icon" %}. + * To edit a saved search, to the right of the search, click {% octicon "pencil" aria-label="The pencil icon" %}. + * To delete a saved search, to the right of the search, click {% octicon "trash" aria-label="The trash icon" %}. ## Using the search results view diff --git a/content/search-github/searching-on-github/finding-files-on-github.md b/content/search-github/searching-on-github/finding-files-on-github.md index 92c2cf3e4025..ba2bd09c398e 100644 --- a/content/search-github/searching-on-github/finding-files-on-github.md +++ b/content/search-github/searching-on-github/finding-files-on-github.md @@ -16,8 +16,8 @@ topics: **Tips:** -- By default, file finder results exclude some directories like `build`, `log`, `tmp`, and `vendor`. To search for files in these directories, {% ifversion code-search-upgrade %}use the [`path` code search qualifier](/search-github/github-code-search/understanding-github-code-search-syntax#path-qualifier){% else %}use the [`filename` code search qualifier](/search-github/searching-on-github/searching-code#search-by-filename){% endif %}. Alternatively, you can customize which directories are excluded by default [using a `.gitattributes` file](#customizing-excluded-files). -- You can also open the file finder by pressing `t` on your keyboard. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)." +* By default, file finder results exclude some directories like `build`, `log`, `tmp`, and `vendor`. To search for files in these directories, {% ifversion code-search-upgrade %}use the [`path` code search qualifier](/search-github/github-code-search/understanding-github-code-search-syntax#path-qualifier){% else %}use the [`filename` code search qualifier](/search-github/searching-on-github/searching-code#search-by-filename){% endif %}. Alternatively, you can customize which directories are excluded by default [using a `.gitattributes` file](#customizing-excluded-files). +* You can also open the file finder by pressing `t` on your keyboard. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)." {% endtip %} @@ -43,15 +43,15 @@ topics: By default, file finder results do not include files in the following directories if they exist at your repository root: -- `.git` -- `.hg` -- `.sass-cache` -- `.svn` -- `build` -- `dot_git` -- `log` -- `tmp` -- `vendor` +* `.git` +* `.hg` +* `.sass-cache` +* `.svn` +* `build` +* `dot_git` +* `log` +* `tmp` +* `vendor` You can override these default exclusions using a `.gitattributes` file. @@ -67,6 +67,6 @@ Note that this override requires the use of the recursive glob pattern (`**`). F ## Further reading -- "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)" -- "[AUTOTITLE](/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github)" -- [`.gitattributes`](https://git-scm.com/docs/gitattributes) in the Git documentation +* "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)" +* "[AUTOTITLE](/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github)" +* [`.gitattributes`](https://git-scm.com/docs/gitattributes) in the Git documentation diff --git a/content/search-github/searching-on-github/searching-code.md b/content/search-github/searching-on-github/searching-code.md index 159b4bbf0fad..3c1f94dc5867 100644 --- a/content/search-github/searching-on-github/searching-code.md +++ b/content/search-github/searching-on-github/searching-code.md @@ -35,17 +35,17 @@ You can only search code using these code search qualifiers. Search qualifiers s Due to the complexity of searching code, there are some restrictions on how searches are performed: -- {% data reusables.search.required_login %} -- Code in [forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) is only searchable if the fork has more stars than the parent repository, and the forked repository has at least one pushed commit after being created. Forks with fewer stars than the parent repository or no commits are **not** indexed for code search. To include forks with more stars than their parent and at least one pushed commit in the search results, you will need to add `fork:true` or `fork:only` to your query. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-in-forks)." -- Only the _default branch_ is indexed for code search.{% ifversion fpt or ghec %} -- Only files smaller than 384 KB are searchable.{% else %}* Only files smaller than 5 MB are searchable. -- Only the first 500 KB of each file is searchable.{% endif %} -- Up to 4,000 private{% ifversion ghec or ghes %} and internal{% endif %} repositories are searchable. These 4,000 repositories will be the most recently updated of the first 10,000 private{% ifversion ghec or ghes %} and internal{% endif %} repositories that you have access to. -- Only repositories with fewer than 500,000 files are searchable.{% ifversion fpt or ghec %} -- Only repositories that have had activity or have been returned in search results in the last year are searchable.{% endif %} -- Except with [`filename`](#search-by-filename) searches, you must always include at least one search term when searching source code. For example, searching for [`language:javascript`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ajavascript&type=Code&ref=searchresults) is not valid, while [`amazing language:javascript`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ajavascript&type=Code&ref=searchresults) is. -- At most, search results can show two fragments from the same file, but there may be more results within the file. -- You can't use the following wildcard characters as part of your search query: . , : ; / \ ` ' " = * ! ? # $ & + ^ | ~ < > ( ) { } [ ] @. The search will simply ignore these symbols. +* {% data reusables.search.required_login %} +* Code in [forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) is only searchable if the fork has more stars than the parent repository, and the forked repository has at least one pushed commit after being created. Forks with fewer stars than the parent repository or no commits are **not** indexed for code search. To include forks with more stars than their parent and at least one pushed commit in the search results, you will need to add `fork:true` or `fork:only` to your query. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-in-forks)." +* Only the _default branch_ is indexed for code search.{% ifversion fpt or ghec %} +* Only files smaller than 384 KB are searchable.{% else %}* Only files smaller than 5 MB are searchable. +* Only the first 500 KB of each file is searchable.{% endif %} +* Up to 4,000 private{% ifversion ghec or ghes %} and internal{% endif %} repositories are searchable. These 4,000 repositories will be the most recently updated of the first 10,000 private{% ifversion ghec or ghes %} and internal{% endif %} repositories that you have access to. +* Only repositories with fewer than 500,000 files are searchable.{% ifversion fpt or ghec %} +* Only repositories that have had activity or have been returned in search results in the last year are searchable.{% endif %} +* Except with [`filename`](#search-by-filename) searches, you must always include at least one search term when searching source code. For example, searching for [`language:javascript`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ajavascript&type=Code&ref=searchresults) is not valid, while [`amazing language:javascript`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ajavascript&type=Code&ref=searchresults) is. +* At most, search results can show two fragments from the same file, but there may be more results within the file. +* You can't use the following wildcard characters as part of your search query: . , : ; / \ ` ' " = * ! ? # $ & + ^ | ~ < > ( ) { } [ ] @. The search will simply ignore these symbols. ## Search by the file contents or file path @@ -116,6 +116,6 @@ The `extension` qualifier matches code files with a certain file extension. ## Further reading -- "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" -- "[AUTOTITLE](/search-github/searching-on-github/searching-in-forks)"{% ifversion fpt or ghec %} -- "[AUTOTITLE](/repositories/working-with-files/using-files/navigating-code-on-github)"{% endif %} +* "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" +* "[AUTOTITLE](/search-github/searching-on-github/searching-in-forks)"{% ifversion fpt or ghec %} +* "[AUTOTITLE](/repositories/working-with-files/using-files/navigating-code-on-github)"{% endif %} diff --git a/content/search-github/searching-on-github/searching-commits.md b/content/search-github/searching-on-github/searching-commits.md index d5172df03fa9..a55583bfbc26 100644 --- a/content/search-github/searching-on-github/searching-commits.md +++ b/content/search-github/searching-on-github/searching-commits.md @@ -113,4 +113,4 @@ The `is` qualifier matches commits from repositories with the specified visibili ## Further reading -- "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" +* "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" diff --git a/content/search-github/searching-on-github/searching-discussions.md b/content/search-github/searching-on-github/searching-discussions.md index a1f6bbbc398d..8710855dce55 100644 --- a/content/search-github/searching-on-github/searching-discussions.md +++ b/content/search-github/searching-on-github/searching-discussions.md @@ -147,4 +147,4 @@ You can filter discussions by specific labels that are applied to discussions. ## Further reading -- "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" +* "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" diff --git a/content/search-github/searching-on-github/searching-for-repositories.md b/content/search-github/searching-on-github/searching-for-repositories.md index f150620dc270..ee1b162d43f3 100644 --- a/content/search-github/searching-on-github/searching-for-repositories.md +++ b/content/search-github/searching-on-github/searching-for-repositories.md @@ -220,5 +220,5 @@ You can search for repositories that have a funding file using the `has:funding- ## Further reading -- "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" -- "[AUTOTITLE](/search-github/searching-on-github/searching-in-forks)" +* "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" +* "[AUTOTITLE](/search-github/searching-on-github/searching-in-forks)" diff --git a/content/search-github/searching-on-github/searching-github-marketplace.md b/content/search-github/searching-on-github/searching-github-marketplace.md index 5995d1d027e7..74bc51a7dad7 100644 --- a/content/search-github/searching-on-github/searching-github-marketplace.md +++ b/content/search-github/searching-on-github/searching-github-marketplace.md @@ -16,8 +16,8 @@ shortTitle: Search GitHub Marketplace You can find apps and actions on {% data variables.product.prodname_marketplace %} in two ways: -- Search from in {% data variables.product.prodname_marketplace %}. -- Search across all of {% data variables.product.prodname_dotcom_the_website %} and then filter the results. +* Search from in {% data variables.product.prodname_marketplace %}. +* Search across all of {% data variables.product.prodname_dotcom_the_website %} and then filter the results. ## Searching in {% data variables.product.prodname_marketplace %} @@ -36,8 +36,8 @@ Anytime you search across all of {% data variables.product.prodname_dotcom_the_w ## Further reading -- "[AUTOTITLE](/actions/learn-github-actions/finding-and-customizing-actions)" -- "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account)" -- "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations)" -- "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-personal-account)" -- "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-organization)" +* "[AUTOTITLE](/actions/learn-github-actions/finding-and-customizing-actions)" +* "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account)" +* "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations)" +* "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-personal-account)" +* "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-organization)" diff --git a/content/search-github/searching-on-github/searching-in-forks.md b/content/search-github/searching-on-github/searching-in-forks.md index 22823a108c6b..916b0b339f0b 100644 --- a/content/search-github/searching-on-github/searching-in-forks.md +++ b/content/search-github/searching-on-github/searching-in-forks.md @@ -34,6 +34,6 @@ The `fork:true` qualifier finds all results that match your search query, includ ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" -- "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories#listing-the-forks-of-a-repository)" -- "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" +* "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories#listing-the-forks-of-a-repository)" +* "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)" diff --git a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index 51ff9f04e4f1..7c69fed80e59 100644 --- a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -19,11 +19,11 @@ You can search for issues and pull requests globally across all of {% data varia {% tip %} **Tips:**{% ifversion ghes %} -- This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.location.product_location %}.{% endif %} -- For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". -- Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive. -- Use a minus (hyphen) symbol to exclude results that match a qualifier. For example, to ignore issues created by the "octocat" user, you'd use `-author:octocat` in your search. Note that this does not work for [missing metadata qualifiers](#search-by-missing-metadata). -- {% data reusables.search.search_issues_and_pull_requests_shortcut %} +* This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.location.product_location %}.{% endif %} +* For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". +* Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive. +* Use a minus (hyphen) symbol to exclude results that match a qualifier. For example, to ignore issues created by the "octocat" user, you'd use `-author:octocat` in your search. Note that this does not work for [missing metadata qualifiers](#search-by-missing-metadata). +* {% data reusables.search.search_issues_and_pull_requests_shortcut %} {% endtip %} @@ -362,10 +362,10 @@ You can search for an issue or pull request that has a locked conversation using You can narrow your search to issues and pull requests that are missing certain metadata, using the `no` qualifier. These qualifiers cannot be combined with the minus (hyphen) symbol to exclude items that are missing metadata. That metadata includes: -- Labels -- Milestones -- Assignees -- Projects +* Labels +* Milestones +* Assignees +* Projects | Qualifier | Example | ------------- | ------------- @@ -376,4 +376,4 @@ You can narrow your search to issues and pull requests that are missing certain ## Further reading -- "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" +* "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" diff --git a/content/search-github/searching-on-github/searching-topics.md b/content/search-github/searching-on-github/searching-topics.md index 62b8200d1358..95010568206d 100644 --- a/content/search-github/searching-on-github/searching-topics.md +++ b/content/search-github/searching-on-github/searching-topics.md @@ -51,4 +51,4 @@ You can use the `topic:` qualifier to find every repository connected to a parti ## Further reading -- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics)" +* "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics)" diff --git a/content/search-github/searching-on-github/searching-users.md b/content/search-github/searching-on-github/searching-users.md index e3665f4a9890..4f6ae1d725cd 100644 --- a/content/search-github/searching-on-github/searching-users.md +++ b/content/search-github/searching-on-github/searching-users.md @@ -102,4 +102,4 @@ You can search for users and organizations who can be sponsored on {% data varia ## Further reading -- "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" +* "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" diff --git a/content/search-github/searching-on-github/searching-wikis.md b/content/search-github/searching-on-github/searching-wikis.md index 8e38efe2c0e5..2234f50e172b 100644 --- a/content/search-github/searching-on-github/searching-wikis.md +++ b/content/search-github/searching-on-github/searching-wikis.md @@ -47,4 +47,4 @@ The `updated` qualifier matches wiki pages that were last updated within the spe ## Further reading -- "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" +* "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" diff --git a/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md b/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md index 39a4d5b924ca..799f6fe7924c 100644 --- a/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md +++ b/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md @@ -22,57 +22,57 @@ You are responsible for using the Service in compliance with all applicable laws We do not allow content or activity on GitHub that: -- is unlawful or promotes unlawful activities; +* is unlawful or promotes unlawful activities; -- is [sexually obscene](/site-policy/acceptable-use-policies/github-sexually-obscene-content) or relates to sexual exploitation or abuse, including of minors; +* is [sexually obscene](/site-policy/acceptable-use-policies/github-sexually-obscene-content) or relates to sexual exploitation or abuse, including of minors; -- is libelous, defamatory, or fraudulent; +* is libelous, defamatory, or fraudulent; -- is [discriminatory or abusive](/site-policy/acceptable-use-policies/github-hate-speech-and-discrimination) toward any individual or group; +* is [discriminatory or abusive](/site-policy/acceptable-use-policies/github-hate-speech-and-discrimination) toward any individual or group; -- is [false, inaccurate, or intentionally deceptive information](/site-policy/acceptable-use-policies/github-misinformation-and-disinformation) and likely to adversely affect the public interest (including health, safety, election integrity, and civic participation); +* is [false, inaccurate, or intentionally deceptive information](/site-policy/acceptable-use-policies/github-misinformation-and-disinformation) and likely to adversely affect the public interest (including health, safety, election integrity, and civic participation); -- [harasses or abuses](/site-policy/acceptable-use-policies/github-bullying-and-harassment) another individual or group, including our employees, officers, and agents, or other users; +* [harasses or abuses](/site-policy/acceptable-use-policies/github-bullying-and-harassment) another individual or group, including our employees, officers, and agents, or other users; -- [threatens or incites violence](/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content) toward any individual or group, especially on the basis of who they are; +* [threatens or incites violence](/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content) toward any individual or group, especially on the basis of who they are; -- [gratuitously depicts or glorifies violence](/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content), including violent images; or +* [gratuitously depicts or glorifies violence](/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content), including violent images; or -- is off-topic, or interacts with platform features in a way that significantly or repeatedly [disrupts the experience of other users](/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users). +* is off-topic, or interacts with platform features in a way that significantly or repeatedly [disrupts the experience of other users](/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users). ## 3. Intellectual Property, Authenticity, and Private Information We do not allow content or activity on GitHub that: -- infringes any proprietary right of any party, including patent, trademark, trade secret, copyright, right of publicity, or other right; +* infringes any proprietary right of any party, including patent, trademark, trade secret, copyright, right of publicity, or other right; -- unlawfully shares unauthorized product licensing keys, software for generating unauthorized product licensing keys, or software for bypassing checks for product licensing keys, including extension of a free license beyond its trial period; +* unlawfully shares unauthorized product licensing keys, software for generating unauthorized product licensing keys, or software for bypassing checks for product licensing keys, including extension of a free license beyond its trial period; -- [impersonates any person or entity](/site-policy/acceptable-use-policies/github-impersonation), including any of our employees or representatives, including through false association with GitHub, or by fraudulently misrepresenting your identity or site's purpose; or +* [impersonates any person or entity](/site-policy/acceptable-use-policies/github-impersonation), including any of our employees or representatives, including through false association with GitHub, or by fraudulently misrepresenting your identity or site's purpose; or -- [violates the privacy of any third party](/site-policy/acceptable-use-policies/github-doxxing-and-invasion-of-privacy), such as by posting another person's personal information without consent. +* [violates the privacy of any third party](/site-policy/acceptable-use-policies/github-doxxing-and-invasion-of-privacy), such as by posting another person's personal information without consent. ## 4. Spam and Inauthentic Activity on GitHub We do not allow content or activity on GitHub that is: -- automated excessive bulk activity and coordinated inauthentic activity, such as - - spamming - - cryptocurrency mining; -- bulk distribution of promotions and advertising prohibited by GitHub terms and policies; -- inauthentic interactions, such as fake accounts and automated inauthentic activity; -- rank abuse, such as automated starring or following; -- creation of or participation in secondary markets for the purpose of the proliferation of inauthentic activity; -- using GitHub as a platform for propagating abuse on other platforms; -- phishing or attempted phishing; or -- using our servers for any form of excessive automated bulk activity, to place undue burden on our servers through automated means, or to relay any form of unsolicited advertising or solicitation through our servers, such as get-rich-quick schemes; -- incentivized by (or incentivizes inauthentic engagement with) rewards such as cryptocurrency airdrops, tokens, credits, gifts or other give-aways. +* automated excessive bulk activity and coordinated inauthentic activity, such as + * spamming + * cryptocurrency mining; +* bulk distribution of promotions and advertising prohibited by GitHub terms and policies; +* inauthentic interactions, such as fake accounts and automated inauthentic activity; +* rank abuse, such as automated starring or following; +* creation of or participation in secondary markets for the purpose of the proliferation of inauthentic activity; +* using GitHub as a platform for propagating abuse on other platforms; +* phishing or attempted phishing; or +* using our servers for any form of excessive automated bulk activity, to place undue burden on our servers through automated means, or to relay any form of unsolicited advertising or solicitation through our servers, such as get-rich-quick schemes; +* incentivized by (or incentivizes inauthentic engagement with) rewards such as cryptocurrency airdrops, tokens, credits, gifts or other give-aways. ## 5. Site Access and Safety We do not allow content or activity on GitHub that: -- directly supports [unlawful active attack or malware campaigns](/site-policy/acceptable-use-policies/github-active-malware-or-exploits) that are causing technical harms — such as using our platform to deliver malicious executables or as attack infrastructure, for example by organizing denial of service attacks or managing command and control servers — with no implicit or explicit dual-use purpose prior to the abuse occurring; or -- uses our servers to disrupt or to attempt to disrupt, or to gain or to attempt to gain unauthorized access to, any service, device, data, account or network. Please note, activities permitted under bug bounty programs, such as the [GitHub Bug Bounty program](https://bounty.github.com), are not considered “unauthorized,” but must only affect the organization whose bug bounty program authorized the activity. +* directly supports [unlawful active attack or malware campaigns](/site-policy/acceptable-use-policies/github-active-malware-or-exploits) that are causing technical harms — such as using our platform to deliver malicious executables or as attack infrastructure, for example by organizing denial of service attacks or managing command and control servers — with no implicit or explicit dual-use purpose prior to the abuse occurring; or +* uses our servers to disrupt or to attempt to disrupt, or to gain or to attempt to gain unauthorized access to, any service, device, data, account or network. Please note, activities permitted under bug bounty programs, such as the [GitHub Bug Bounty program](https://bounty.github.com), are not considered “unauthorized,” but must only affect the organization whose bug bounty program authorized the activity. ## 6. Services Usage Limits @@ -82,8 +82,8 @@ You will not reproduce, duplicate, copy, sell, resell or exploit any portion of You may use information from our Service for the following reasons, regardless of whether the information was scraped, collected through our API, or obtained otherwise: -- Researchers may use public, non-personal information from the Service for research purposes, only if any publications resulting from that research are [open access](https://en.wikipedia.org/wiki/Open_access). -- Archivists may use public information from the Service for archival purposes. +* Researchers may use public, non-personal information from the Service for research purposes, only if any publications resulting from that research are [open access](https://en.wikipedia.org/wiki/Open_access). +* Archivists may use public information from the Service for archival purposes. Scraping refers to extracting information from our Service via an automated process, such as a bot or webcrawler. Scraping does not refer to the collection of information through our API. Please see Section H of our [Terms of Service](/site-policy/github-terms/github-terms-of-service#h-api-terms) for our API Terms. diff --git a/content/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md b/content/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md index 7f66f83348f4..55a77575f7de 100644 --- a/content/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md +++ b/content/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md @@ -21,7 +21,7 @@ Being part of a community includes not taking advantage of other members of the To facilitate a path to abuse resolution with project maintainers themselves, prior to escalation to GitHub abuse reports, we recommend, but do not require, that repository owners take the following steps when posting potentially harmful security research content: -- Clearly identify and describe any potentially harmful content in a disclaimer in the project’s README.md file or source code comments. -- Provide a preferred contact method for any 3rd party abuse inquiries through a SECURITY.md file in the repository (e.g. "Please create an issue on this repository for any questions or concerns"). Such a contact method allows 3rd parties to reach out to project maintainers directly and potentially resolve concerns without the need to file abuse reports. +* Clearly identify and describe any potentially harmful content in a disclaimer in the project’s README.md file or source code comments. +* Provide a preferred contact method for any 3rd party abuse inquiries through a SECURITY.md file in the repository (e.g. "Please create an issue on this repository for any questions or concerns"). Such a contact method allows 3rd parties to reach out to project maintainers directly and potentially resolve concerns without the need to file abuse reports. _GitHub considers the npm registry to be a platform used primarily for installation and run-time use of code, and not for research._ diff --git a/content/site-policy/acceptable-use-policies/github-appeal-and-reinstatement.md b/content/site-policy/acceptable-use-policies/github-appeal-and-reinstatement.md index 5cb30eb8cab4..0894015fc32a 100644 --- a/content/site-policy/acceptable-use-policies/github-appeal-and-reinstatement.md +++ b/content/site-policy/acceptable-use-policies/github-appeal-and-reinstatement.md @@ -14,10 +14,10 @@ While the majority of interactions between individuals in GitHub’s community f Both Appeals and Reinstatements may arise in relation to decisions to disable or limit access to content or an account, including decisions whether or not to: -- Remove, disable access to, or restrict visibility of content -- Suspend or terminate access to an account -- Suspend or terminate access to the service, in whole or in part -- Suspend, terminate or otherwise restrict the ability to monetize content +* Remove, disable access to, or restrict visibility of content +* Suspend or terminate access to an account +* Suspend or terminate access to the service, in whole or in part +* Suspend, terminate or otherwise restrict the ability to monetize content A “Reinstatement” is where a user wishes to regain access to their account or content and is willing to make any necessary changes to address the violation and agrees not to violate our terms going forward. diff --git a/content/site-policy/acceptable-use-policies/github-bullying-and-harassment.md b/content/site-policy/acceptable-use-policies/github-bullying-and-harassment.md index a62c7da0287c..39d603a092be 100644 --- a/content/site-policy/acceptable-use-policies/github-bullying-and-harassment.md +++ b/content/site-policy/acceptable-use-policies/github-bullying-and-harassment.md @@ -13,11 +13,11 @@ redirect_from: We do not tolerate harassment, bullying, or abuse of any kind, whether directly or by encouraging others to take part in the prohibited conduct. This includes: -- Targeted personal attacks -- Piling on to or orchestrating [disruptive](/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users) activity in a way that amounts to abuse -- Following another user around the platform in a manner that causes intimidation -- Making sexual advances or comments directed at another individual -- Disingenuously participating in conversation in a way that instigates conflict or undermines sincere discussion -- Creating alternative accounts specifically to evade moderation action taken by GitHub staff or users +* Targeted personal attacks +* Piling on to or orchestrating [disruptive](/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users) activity in a way that amounts to abuse +* Following another user around the platform in a manner that causes intimidation +* Making sexual advances or comments directed at another individual +* Disingenuously participating in conversation in a way that instigates conflict or undermines sincere discussion +* Creating alternative accounts specifically to evade moderation action taken by GitHub staff or users Please note, not all unwelcome conduct is necessarily considered harassment. For example, disagreeing with another user or downvoting their comments may not rise to the level of harassment on our platform. In addition, sharing criticism of public figures or projects, or topics of public interest, does not necessarily fall under this policy. However, we encourage you to be mindful in how you engage with other users and the platform, as this activity may still violate our restriction on disrupting the experience of other users. diff --git a/content/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users.md b/content/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users.md index 02fc39feaa83..8bcf8a15a6cc 100644 --- a/content/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users.md +++ b/content/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users.md @@ -15,12 +15,12 @@ Being part of a community includes recognizing how your behavior affects others We do not allow behavior that significantly or continually disrupts the experience of other users. This includes: -- Posting off-topic comments -- Opening empty or meaningless issues or pull requests -- Starring and/or following accounts or repositories in large volume in a short period of time -- Creating nonsensical or irrelevant code reviews -- Engaging with platform features in a way that causes excessive notifications for other users -- Using any other platform feature in a way that creates disruption +* Posting off-topic comments +* Opening empty or meaningless issues or pull requests +* Starring and/or following accounts or repositories in large volume in a short period of time +* Creating nonsensical or irrelevant code reviews +* Engaging with platform features in a way that causes excessive notifications for other users +* Using any other platform feature in a way that creates disruption While we encourage maintainers to moderate their own projects on an individual basis, GitHub staff may take further restrictive action against accounts that are engaging in these types of behaviors. diff --git a/content/site-policy/acceptable-use-policies/github-doxxing-and-invasion-of-privacy.md b/content/site-policy/acceptable-use-policies/github-doxxing-and-invasion-of-privacy.md index 7f4981108e5f..29a62d3773fa 100644 --- a/content/site-policy/acceptable-use-policies/github-doxxing-and-invasion-of-privacy.md +++ b/content/site-policy/acceptable-use-policies/github-doxxing-and-invasion-of-privacy.md @@ -13,15 +13,15 @@ redirect_from: Don't post other people's personal information. This includes: -- Personal, private email addresses -- Phone numbers -- Physical addresses or other private location information -- Bank account information or credit card numbers -- Social Security/National Identity numbers -- Passwords -- Voter information -- Medical information and personal biometric data -- Other private information that may pose a safety or security risk +* Personal, private email addresses +* Phone numbers +* Physical addresses or other private location information +* Bank account information or credit card numbers +* Social Security/National Identity numbers +* Passwords +* Voter information +* Medical information and personal biometric data +* Other private information that may pose a safety or security risk We may consider other information, such as photos or videos that were taken or distributed without the subject's consent, to be an invasion of privacy, especially when such material presents a safety risk to the subject, such as in the case of intimidation or harassment. diff --git a/content/site-policy/acceptable-use-policies/github-hate-speech-and-discrimination.md b/content/site-policy/acceptable-use-policies/github-hate-speech-and-discrimination.md index b05ddbd3bce8..5be67a60d5f0 100644 --- a/content/site-policy/acceptable-use-policies/github-hate-speech-and-discrimination.md +++ b/content/site-policy/acceptable-use-policies/github-hate-speech-and-discrimination.md @@ -13,12 +13,12 @@ redirect_from: GitHub does not tolerate speech that attacks or promotes hate toward an individual or group of people on the basis of who they are, including age, body size, ability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, sexual identity, or sexual orientation. This includes: -- Mocking, attacking, or excluding a person or group based on their beliefs or the characteristics listed above -- Displaying clear affiliation or identification with known terrorist or violent extremist organizations -- Supporting or promoting hate groups or hate-based conspiracy theories -- Sharing symbols or images synonymous with hate -- Using harmful stereotypes, slurs, or dehumanizing speech -- Attacking an individual based on their perceived gender -- Dog whistling; or using coded or suggestive language and/or symbols to promote abuse or hate +* Mocking, attacking, or excluding a person or group based on their beliefs or the characteristics listed above +* Displaying clear affiliation or identification with known terrorist or violent extremist organizations +* Supporting or promoting hate groups or hate-based conspiracy theories +* Sharing symbols or images synonymous with hate +* Using harmful stereotypes, slurs, or dehumanizing speech +* Attacking an individual based on their perceived gender +* Dog whistling; or using coded or suggestive language and/or symbols to promote abuse or hate While GitHub takes all instances of abuse and harassment on the platform seriously, we are especially committed to fighting hate-based abuse where it disproportionately affects communities that have historically been targeted by such abuse. We aim to make GitHub a place where all individuals feel welcome and safe. diff --git a/content/site-policy/acceptable-use-policies/github-impersonation.md b/content/site-policy/acceptable-use-policies/github-impersonation.md index f347d497a5b6..235addcfe4de 100644 --- a/content/site-policy/acceptable-use-policies/github-impersonation.md +++ b/content/site-policy/acceptable-use-policies/github-impersonation.md @@ -13,11 +13,11 @@ redirect_from: You may not misrepresent your identity or your association with another person or organization. This includes doing any of the following in a way that misleads or deceives others: -- Copying another user's avatar or other personal profile information -- Posting content under another user's email address -- Using a deceptively similar username, organization name, or other namespace -- Accessing an account or organization with another user's token or credentials -- Otherwise posing as another individual or organization +* Copying another user's avatar or other personal profile information +* Posting content under another user's email address +* Using a deceptively similar username, organization name, or other namespace +* Accessing an account or organization with another user's token or credentials +* Otherwise posing as another individual or organization Impersonation is a form of harassment and violation of this policy may lead to loss of access to your account. diff --git a/content/site-policy/acceptable-use-policies/github-misinformation-and-disinformation.md b/content/site-policy/acceptable-use-policies/github-misinformation-and-disinformation.md index 2bb9a4a91f09..65c8b5476313 100644 --- a/content/site-policy/acceptable-use-policies/github-misinformation-and-disinformation.md +++ b/content/site-policy/acceptable-use-policies/github-misinformation-and-disinformation.md @@ -12,10 +12,10 @@ redirect_from: --- You may not post content that presents a distorted view of reality, whether it is inaccurate or false (misinformation) or is intentionally deceptive (disinformation), where such content is likely to result in harm to the public or to interfere with fair and equal opportunities for all to take part in a free and open society. This may include: -- Inaccurate or scientifically unsupported medical claims that endanger public health or safety -- Manipulated media, whether audio or visual, likely to mislead or deceive in a way that may harm the public interest -- False or misleading content likely to interfere with an individual's ability to participate in civic activities -- Unsubstantiated claims that could promote hate or targeted harassment of specific groups of people +* Inaccurate or scientifically unsupported medical claims that endanger public health or safety +* Manipulated media, whether audio or visual, likely to mislead or deceive in a way that may harm the public interest +* False or misleading content likely to interfere with an individual's ability to participate in civic activities +* Unsubstantiated claims that could promote hate or targeted harassment of specific groups of people We encourage active participation in the expression of ideas, perspectives, and experiences and may not be in a position to dispute personal accounts or observations. We generally allow parody and satire that is in line with our [Acceptable Use Polices](/site-policy/acceptable-use-policies/github-acceptable-use-policies), and we consider context to be important in how information is received and understood. When reviewing content under this policy, GitHub will consider the impact of various factors that may help to orient the viewer, such as whether the content has been provided with clear disclaimers, citations to credible sources, or includes other details that clarify the accuracy of the information being shared. diff --git a/content/site-policy/acceptable-use-policies/github-sexually-obscene-content.md b/content/site-policy/acceptable-use-policies/github-sexually-obscene-content.md index c91b6114e1c6..20aa5a1bab57 100644 --- a/content/site-policy/acceptable-use-policies/github-sexually-obscene-content.md +++ b/content/site-policy/acceptable-use-policies/github-sexually-obscene-content.md @@ -13,8 +13,8 @@ redirect_from: We do not tolerate content associated with sexual exploitation or abuse of another individual, including where minors are concerned. We do not allow sexually themed or suggestive content that serves little or no purpose other than to solicit an erotic or shocking response, particularly where that content is amplified by its placement in profiles or other social contexts. This includes: -- Pornographic content -- Non-consensual intimate imagery -- Graphic depictions of sexual acts including photographs, video, animation, drawings, computer-generated images, or text-based content +* Pornographic content +* Non-consensual intimate imagery +* Graphic depictions of sexual acts including photographs, video, animation, drawings, computer-generated images, or text-based content We recognize that not all nudity or content related to sexuality is obscene. We may allow visual and/or textual depictions in artistic, educational, historical or journalistic contexts, or as it relates to victim advocacy. In some cases a disclaimer can help communicate the context of the project. However, please understand that we may choose to limit the content by giving users the option to opt in before viewing. diff --git a/content/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content.md b/content/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content.md index 502b8c441159..65bf8b718031 100644 --- a/content/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content.md +++ b/content/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content.md @@ -15,8 +15,8 @@ redirect_from: You may not use GitHub to organize, promote, encourage, threaten, or incite acts of violence. You may not post content that depicts or glorifies violence or physical harm against human beings or animals. This includes: -- Threatening another individual or group with abuse, harm, sexual violence, or death -- Posting text, imagery, or audio content glorifying or containing a graphic depiction of violence toward oneself, another individual, group, or animal -- Encouraging another individual to engage in self harm +* Threatening another individual or group with abuse, harm, sexual violence, or death +* Posting text, imagery, or audio content glorifying or containing a graphic depiction of violence toward oneself, another individual, group, or animal +* Encouraging another individual to engage in self harm We do not allow violent content to be posted indiscriminately or in a way that is difficult for other users to avoid, such as a profile avatar or an issue comment. However, we understand there may be legitimate reasons to post violent content, such as for educational or documentary purposes, creative works, or depictions of historical events. In those cases, a clear warning or disclaimer can help users make an educated decision as to whether or not they want to engage with such content. Still, GitHub may decide to limit the visibility of such content to those who choose to opt in. diff --git a/content/site-policy/content-removal-policies/dmca-takedown-policy.md b/content/site-policy/content-removal-policies/dmca-takedown-policy.md index 8991c89918a6..d1d9e9bb2a04 100644 --- a/content/site-policy/content-removal-policies/dmca-takedown-policy.md +++ b/content/site-policy/content-removal-policies/dmca-takedown-policy.md @@ -105,8 +105,8 @@ It is the policy of GitHub, in appropriate circumstances and in its sole discret ## G. Submitting Notices If you are ready to submit a notice or a counter notice: -- [How to Submit a DMCA Notice](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice) -- [How to Submit a DMCA Counter Notice](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice) +* [How to Submit a DMCA Notice](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice) +* [How to Submit a DMCA Counter Notice](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice) ## Learn More and Speak Up @@ -114,11 +114,11 @@ If you poke around the Internet, it is not too hard to find commentary and criti We don't presume to have all the answers. But if you are curious, here are a few links to scholarly articles and blog posts we have found with opinions and proposals for reform: -- [Unintended Consequences: Twelve Years Under the DMCA](https://www.eff.org/wp/unintended-consequences-under-dmca) (Electronic Frontier Foundation) -- [Statutory Damages in Copyright Law: A Remedy in Need of Reform](https://papers.ssrn.com/sol3/papers.cfm?abstract_id=1375604) (William & Mary Law Review) -- [Is the Term of Protection of Copyright Too Long?](https://the1709blog.blogspot.com/2012/11/is-term-of-protection-of-copyright-too.html) (The 1709 Blog) -- [If We're Going to Change DMCA's 'Notice & Takedown,' Let's Focus on How Widely It's Abused](https://www.techdirt.com/articles/20140314/11350426579/if-were-going-to-change-dmcas-notice-takedown-lets-focus-how-widely-its-abused.shtml) (TechDirt) -- [Opportunities for Copyright Reform](https://www.cato-unbound.org/issues/january-2013/opportunities-copyright-reform) (Cato Unbound) -- [Fair Use Doctrine and the Digital Millennium Copyright Act: Does Fair Use Exist on the Internet Under the DMCA?](https://digitalcommons.law.scu.edu/lawreview/vol42/iss1/6/) (Santa Clara Law Review) +* [Unintended Consequences: Twelve Years Under the DMCA](https://www.eff.org/wp/unintended-consequences-under-dmca) (Electronic Frontier Foundation) +* [Statutory Damages in Copyright Law: A Remedy in Need of Reform](https://papers.ssrn.com/sol3/papers.cfm?abstract_id=1375604) (William & Mary Law Review) +* [Is the Term of Protection of Copyright Too Long?](https://the1709blog.blogspot.com/2012/11/is-term-of-protection-of-copyright-too.html) (The 1709 Blog) +* [If We're Going to Change DMCA's 'Notice & Takedown,' Let's Focus on How Widely It's Abused](https://www.techdirt.com/articles/20140314/11350426579/if-were-going-to-change-dmcas-notice-takedown-lets-focus-how-widely-its-abused.shtml) (TechDirt) +* [Opportunities for Copyright Reform](https://www.cato-unbound.org/issues/january-2013/opportunities-copyright-reform) (Cato Unbound) +* [Fair Use Doctrine and the Digital Millennium Copyright Act: Does Fair Use Exist on the Internet Under the DMCA?](https://digitalcommons.law.scu.edu/lawreview/vol42/iss1/6/) (Santa Clara Law Review) GitHub doesn't necessarily endorse any of the viewpoints in those articles. We provide the links to encourage you to learn more, form your own opinions, and then reach out to your elected representative(s) (e.g., in the [U.S. Congress](https://www.govtrack.us/congress/members) or [E.U. Parliament](https://www.europarl.europa.eu/meps/en/home)) to seek whatever changes you think should be made. diff --git a/content/site-policy/content-removal-policies/github-private-information-removal-policy.md b/content/site-policy/content-removal-policies/github-private-information-removal-policy.md index bf580cca7edf..a67cff4c02ff 100644 --- a/content/site-policy/content-removal-policies/github-private-information-removal-policy.md +++ b/content/site-policy/content-removal-policies/github-private-information-removal-policy.md @@ -21,20 +21,20 @@ For the purposes of this document, “private information” refers to content t ### Private information removal requests are appropriate for: -- Access credentials, such as user names combined with passwords, access tokens, or other sensitive secrets that can grant access to your organization's server, network, or domain. -- AWS tokens and other similar access credentials that grant access to a third party on your behalf. You must be able to show that the token does belong to you. -- Documentation (such as network diagrams or architecture) that poses a specific security risk for an organization. -- [Information](/site-policy/acceptable-use-policies/github-doxxing-and-invasion-of-privacy) related to, and posing a security risk to, you as an individual (such as social security numbers or other government identification numbers). +* Access credentials, such as user names combined with passwords, access tokens, or other sensitive secrets that can grant access to your organization's server, network, or domain. +* AWS tokens and other similar access credentials that grant access to a third party on your behalf. You must be able to show that the token does belong to you. +* Documentation (such as network diagrams or architecture) that poses a specific security risk for an organization. +* [Information](/site-policy/acceptable-use-policies/github-doxxing-and-invasion-of-privacy) related to, and posing a security risk to, you as an individual (such as social security numbers or other government identification numbers). ### Private information removal requests are _not_ appropriate for: -- Internal server names, IP addresses, and URLs, on their own. You must be able to show that their use in a particular file or piece of code poses a security threat. -- Mere mentions of your company's identity, name, brand, domain name, or other references to your company in files on GitHub. You must be able to articulate why a use of your company's identity is a threat to your company's security posture. -- Entire files or repositories that do not pose a specific security risk, but you believe are otherwise objectionable. -- Requests to remove content that may infringe your or your organization's copyright rights. If you have questions about how GitHub handles copyright-related matters or would like to report potentially infringing content, please review our [DMCA Takedown Policy](/site-policy/content-removal-policies/dmca-takedown-policy). The private information removal process is generally not intended for the removal of full files or repositories — only for the specific pieces of private information in those files. While there may be cases where files are filled entirely with private information, you must justify the security risk for the removal of such files, and this may increase the time required to process your request. -- Trademark disputes. If you have questions about how GitHub handles trademark-related matters or would like to report content containing your organization's trade or service marks, please review our [Trademark Policy](/site-policy/content-removal-policies/github-trademark-policy). -- Privacy complaints. If you wish to access, transfer, change, or delete your personal information on GitHub, please contact us via [our Privacy contact form](https://github.com/contact/privacy). -- Content governed by our [Community Guidelines](/site-policy/github-terms/github-community-guidelines), such as malware or general-purpose tools. If you have questions about our Community Guidelines or believe that content on GitHub might violate our guidelines, you can contact us through the {% data variables.contact.contact_support_portal %} to report content. +* Internal server names, IP addresses, and URLs, on their own. You must be able to show that their use in a particular file or piece of code poses a security threat. +* Mere mentions of your company's identity, name, brand, domain name, or other references to your company in files on GitHub. You must be able to articulate why a use of your company's identity is a threat to your company's security posture. +* Entire files or repositories that do not pose a specific security risk, but you believe are otherwise objectionable. +* Requests to remove content that may infringe your or your organization's copyright rights. If you have questions about how GitHub handles copyright-related matters or would like to report potentially infringing content, please review our [DMCA Takedown Policy](/site-policy/content-removal-policies/dmca-takedown-policy). The private information removal process is generally not intended for the removal of full files or repositories — only for the specific pieces of private information in those files. While there may be cases where files are filled entirely with private information, you must justify the security risk for the removal of such files, and this may increase the time required to process your request. +* Trademark disputes. If you have questions about how GitHub handles trademark-related matters or would like to report content containing your organization's trade or service marks, please review our [Trademark Policy](/site-policy/content-removal-policies/github-trademark-policy). +* Privacy complaints. If you wish to access, transfer, change, or delete your personal information on GitHub, please contact us via [our Privacy contact form](https://github.com/contact/privacy). +* Content governed by our [Community Guidelines](/site-policy/github-terms/github-community-guidelines), such as malware or general-purpose tools. If you have questions about our Community Guidelines or believe that content on GitHub might violate our guidelines, you can contact us through the {% data variables.contact.contact_support_portal %} to report content. ## Things to Know diff --git a/content/site-policy/content-removal-policies/github-trademark-policy.md b/content/site-policy/content-removal-policies/github-trademark-policy.md index 930abdce00f8..c4a2d6c9a3f5 100644 --- a/content/site-policy/content-removal-policies/github-trademark-policy.md +++ b/content/site-policy/content-removal-policies/github-trademark-policy.md @@ -21,8 +21,8 @@ Using another's trademark in a way that has nothing to do with the product or se When we receive reports of trademark policy violations from holders of federal or international trademark registrations, we review the account and may take the following actions: -- When there is a clear intent to mislead others through the unauthorized use of a trademark, GitHub will suspend the account and notify the account holder. -- When we determine that an account appears to be confusing users, but is not purposefully passing itself off as the trademarked good or service, we give the account holder an opportunity to clear up any potential confusion. We may also release a username for the trademark holder's active use. +* When there is a clear intent to mislead others through the unauthorized use of a trademark, GitHub will suspend the account and notify the account holder. +* When we determine that an account appears to be confusing users, but is not purposefully passing itself off as the trademarked good or service, we give the account holder an opportunity to clear up any potential confusion. We may also release a username for the trademark holder's active use. ## How Do I Report a Trademark Policy Violation? @@ -32,22 +32,22 @@ Holders of registered trademarks can report possible trademark policy violations In order to investigate trademark policy violations, please provide all of the following information: -- Username of the reported account -- Your company name -- Your company GitHub account (if there is one) -- Company website -- Your trademarked word, symbol, etc. -- Trademark registration number -- Trademark registration office (e.g., USPTO) -- Description of confusion (e.g., passing off as your company, including specific descriptions of content or behavior) -- Requested Action (e.g., removal of violating account or transfer of trademarked username to an existing company account) -- Include the following statement: "I have a good faith belief that use of the trademark described above is not authorized by the trademark owner, or its agent, or the law. I have taken nominative and other fair uses into consideration." -- Also include the following statement: "I swear, under penalty of perjury, that the information in this notification is accurate and that I am the trademark owner, or am authorized to act on behalf of the owner, of an exclusive right that is allegedly infringed." -- Include your physical or electronic signature. - -- Note: A federal or international trademark registration number is required. If the name you are reporting is **not** a registered mark (e.g., a government agency or non-profit organization), please let us know: - - Your first and last name - - Title - - Address - - Phone - - Email (must be from company domain) +* Username of the reported account +* Your company name +* Your company GitHub account (if there is one) +* Company website +* Your trademarked word, symbol, etc. +* Trademark registration number +* Trademark registration office (e.g., USPTO) +* Description of confusion (e.g., passing off as your company, including specific descriptions of content or behavior) +* Requested Action (e.g., removal of violating account or transfer of trademarked username to an existing company account) +* Include the following statement: "I have a good faith belief that use of the trademark described above is not authorized by the trademark owner, or its agent, or the law. I have taken nominative and other fair uses into consideration." +* Also include the following statement: "I swear, under penalty of perjury, that the information in this notification is accurate and that I am the trademark owner, or am authorized to act on behalf of the owner, of an exclusive right that is allegedly infringed." +* Include your physical or electronic signature. + +* Note: A federal or international trademark registration number is required. If the name you are reporting is **not** a registered mark (e.g., a government agency or non-profit organization), please let us know: + * Your first and last name + * Title + * Address + * Phone + * Email (must be from company domain) diff --git a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md index 19357287414c..5300fdac4085 100644 --- a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md +++ b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md @@ -31,9 +31,9 @@ In order to file a counter notice, you must have "a good faith belief that the m ***Copyright Laws Are Complicated.*** Sometimes a takedown notice might allege infringement in a way that seems odd or indirect. Copyright laws are complicated and can lead to some unexpected results. In some cases a takedown notice might allege that your source code infringes because of what it can do after it is compiled and run. For example: - - The notice may claim that your software is used to [circumvent access controls](https://www.copyright.gov/title17/92chap12.html) to copyrighted works. - - [Sometimes](https://www.copyright.gov/docs/mgm/) distributing software can be copyright infringement, if you induce end users to use the software to infringe copyrighted works. - - A copyright complaint might also be based on [non-literal copying](https://en.wikipedia.org/wiki/Substantial_similarity) of design elements in the software, rather than the source code itself — in other words, someone has sent a notice saying they think your _design_ looks too similar to theirs. + * The notice may claim that your software is used to [circumvent access controls](https://www.copyright.gov/title17/92chap12.html) to copyrighted works. + * [Sometimes](https://www.copyright.gov/docs/mgm/) distributing software can be copyright infringement, if you induce end users to use the software to infringe copyrighted works. + * A copyright complaint might also be based on [non-literal copying](https://en.wikipedia.org/wiki/Substantial_similarity) of design elements in the software, rather than the source code itself — in other words, someone has sent a notice saying they think your _design_ looks too similar to theirs. These are just a few examples of the complexities of copyright law. Since there are many nuances to the law and some unsettled questions in these types of cases, it is especially important to get professional advice if the infringement allegations do not seem straightforward. diff --git a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md index be19e531ba9b..7a680023c374 100644 --- a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md +++ b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md @@ -32,11 +32,11 @@ As with all legal matters, it is always best to consult with a professional abou There are a number of reasons why code is different from other creative content. For instance: -- A repository may include bits and pieces of code from many different people, but only one file or even a sub-routine within a file infringes your copyrights. -- Code mixes functionality with creative expression, but copyright only protects the expressive elements, not the parts that are functional. -- There are often licenses to consider. Just because a piece of code has a copyright notice does not necessarily mean that it is infringing. It is possible that the code is being used in accordance with an open-source license. -- A particular use may be [fair-use](https://www.lumendatabase.org/topics/22) if it only uses a small amount of copyrighted content, uses that content in a transformative way, uses it for educational purposes, or some combination of the above. Because code naturally lends itself to such uses, each use case is different and must be considered separately. -- Code may be alleged to infringe in many different ways, requiring detailed explanations and identifications of works. +* A repository may include bits and pieces of code from many different people, but only one file or even a sub-routine within a file infringes your copyrights. +* Code mixes functionality with creative expression, but copyright only protects the expressive elements, not the parts that are functional. +* There are often licenses to consider. Just because a piece of code has a copyright notice does not necessarily mean that it is infringing. It is possible that the code is being used in accordance with an open-source license. +* A particular use may be [fair-use](https://www.lumendatabase.org/topics/22) if it only uses a small amount of copyrighted content, uses that content in a transformative way, uses it for educational purposes, or some combination of the above. Because code naturally lends itself to such uses, each use case is different and must be considered separately. +* Code may be alleged to infringe in many different ways, requiring detailed explanations and identifications of works. This list isn't exhaustive, which is why speaking to a legal professional about your proposed complaint is doubly important when dealing with code. @@ -58,7 +58,7 @@ GitHub exercises little discretion in the process other than determining whether 1. **Identify the copyrighted work you believe has been infringed.** This information is important because it helps the affected user evaluate your claim and give them the ability to compare your work to theirs. The specificity of your identification will depend on the nature of the work you believe has been infringed. If you have published your work, you might be able to just link back to a web page where it lives. If it is proprietary and not published, you might describe it and explain that it is proprietary. If you have registered it with the Copyright Office, you should include the registration number. If you are alleging that the hosted content is a direct, literal copy of your work, you can also just explain that fact. 1. **Identify the material that you allege is infringing the copyrighted work listed in item #2, above.** It is important to be as specific as possible in your identification. This identification needs to be reasonably sufficient to permit GitHub to locate the material. At a minimum, this means that you should include the URL to the material allegedly infringing your copyright. If you allege that less than a whole repository infringes, identify the specific file(s) or line numbers within a file that you allege infringe. If you allege that all of the content at a URL infringes, please be explicit about that as well. - - Please note that GitHub will _not_ automatically disable [forks](/site-policy/content-removal-policies/dmca-takedown-policy#b-what-about-forks-or-whats-a-fork) when disabling a parent repository. If you have investigated and analyzed the forks of a repository and believe that they are also infringing, please explicitly identify each allegedly infringing fork. Please also confirm that you have investigated each individual case and that your sworn statements apply to each identified fork. In rare cases, you may be alleging copyright infringement in a full repository that is actively being forked. If at the time that you submitted your notice, you identified all existing forks of that repository as allegedly infringing, we would process a valid claim against all forks in that network at the time we process the notice. We would do this given the likelihood that all newly created forks would contain the same content. In addition, if the reported network that contains the allegedly infringing content is larger than one hundred (100) repositories and thus would be difficult to review in its entirety, we may consider disabling the entire network if you state in your notice that, "Based on the representative number of forks you have reviewed, I believe that all or most of the forks are infringing to the same extent as the parent repository." Your sworn statement would apply to this statement. + * Please note that GitHub will _not_ automatically disable [forks](/site-policy/content-removal-policies/dmca-takedown-policy#b-what-about-forks-or-whats-a-fork) when disabling a parent repository. If you have investigated and analyzed the forks of a repository and believe that they are also infringing, please explicitly identify each allegedly infringing fork. Please also confirm that you have investigated each individual case and that your sworn statements apply to each identified fork. In rare cases, you may be alleging copyright infringement in a full repository that is actively being forked. If at the time that you submitted your notice, you identified all existing forks of that repository as allegedly infringing, we would process a valid claim against all forks in that network at the time we process the notice. We would do this given the likelihood that all newly created forks would contain the same content. In addition, if the reported network that contains the allegedly infringing content is larger than one hundred (100) repositories and thus would be difficult to review in its entirety, we may consider disabling the entire network if you state in your notice that, "Based on the representative number of forks you have reviewed, I believe that all or most of the forks are infringing to the same extent as the parent repository." Your sworn statement would apply to this statement. 1. **Explain what the affected user would need to do in order to remedy the infringement.** Again, specificity is important. When we pass your complaint along to the user, this will tell them what they need to do in order to avoid having the rest of their content disabled. Does the user just need to add a statement of attribution? Do they need to delete certain lines within their code, or entire files? Of course, we understand that in some cases, all of a user's content may be alleged to infringe and there's nothing they could do short of deleting it all. If that's the case, please make that clear as well. diff --git a/content/site-policy/github-company-policies/github-anti-bribery-statement.md b/content/site-policy/github-company-policies/github-anti-bribery-statement.md index c53bcd41a947..e53feccf7498 100644 --- a/content/site-policy/github-company-policies/github-anti-bribery-statement.md +++ b/content/site-policy/github-company-policies/github-anti-bribery-statement.md @@ -10,10 +10,10 @@ topics: - Legal --- GitHub upholds our commitment to ethical business practices, including by prohibiting bribery and corruption. As [Transparency International](https://www.transparency.org/what-is-corruption#costs-of-corruption) explains, the costs of corruption are -- **political**, by posing a major obstacle to democracy and the rule of law -- **economic**, by depleting national wealth -- **social**, by undermining people’s trust in political society, institutions, and leaders -- **environmental**, by facilitating non-enforcement of environmental laws and regulations. +* **political**, by posing a major obstacle to democracy and the rule of law +* **economic**, by depleting national wealth +* **social**, by undermining people’s trust in political society, institutions, and leaders +* **environmental**, by facilitating non-enforcement of environmental laws and regulations. According to the [World Bank](https://www.worldbank.org/en/topic/governance/brief/anti-corruption) in 2017, businesses and individuals pay an estimated $1.5 trillion in bribes each year. @@ -35,19 +35,19 @@ GitHub’s **Gifts and Entertainment Policy** explains that bribery is not permi ## Training for our employees GitHub employees are required to participate in training on corruption, including bribery. We also provide additional training for particularly relevant people and teams, such as our sales team. The training explains relevant elements of the U.S. Foreign Corrupt Practices Act and the U.K. Bribery Act of 2010. For example, -- definition and structural effects of corruption -- who is covered, including - - public officials or others in a position of power - - third parties -- what kind of activity is covered, including - - cash, gifts, travel, and entertainment - - facilitation payments - - charitable contributions and sponsorship -- for what purpose, including - - intent - - improper advantage or influence -- due diligence and red flags -- record-keeping requirements +* definition and structural effects of corruption +* who is covered, including + * public officials or others in a position of power + * third parties +* what kind of activity is covered, including + * cash, gifts, travel, and entertainment + * facilitation payments + * charitable contributions and sponsorship +* for what purpose, including + * intent + * improper advantage or influence +* due diligence and red flags +* record-keeping requirements In addition, the training covers GitHub’s internal policies related to anti-corruption and bribery, including our non-retaliation (whistleblower) policy. @@ -55,5 +55,5 @@ While the U.S. FCPA is focused on interactions with government officials, the U. ## Engaging our Partners -- GitHub’s standard **resale agreements with Channel Partners** include mandatory anti-corruption clauses. Going forward, GitHub now requires our Channel Partners to commit to complying with this Anti-Corruption Statement. -- Going forward, GitHub’s **vendor contracts** now require a commitment to comply with Microsoft's Supplier Code of Conduct or this Anti-Corruption Statement. +* GitHub’s standard **resale agreements with Channel Partners** include mandatory anti-corruption clauses. Going forward, GitHub now requires our Channel Partners to commit to complying with this Anti-Corruption Statement. +* Going forward, GitHub’s **vendor contracts** now require a commitment to comply with Microsoft's Supplier Code of Conduct or this Anti-Corruption Statement. diff --git a/content/site-policy/github-company-policies/github-gifts-and-entertainment-policy.md b/content/site-policy/github-company-policies/github-gifts-and-entertainment-policy.md index d3a61ce922d0..86673ccf84ee 100644 --- a/content/site-policy/github-company-policies/github-gifts-and-entertainment-policy.md +++ b/content/site-policy/github-company-policies/github-gifts-and-entertainment-policy.md @@ -33,20 +33,20 @@ As for other customers or prospective customers, certain things might seem trivi 🙅 _Here are some other things that aren't ok:_ -- First class airfare to GitHub offices for Executive Briefings ✈️+🍾 -- Winery tours 🍷 -- Recommending a friend’s kid to a prestigious private school for admission 🎓 -- Tickets to Disneyland 👸, the World Cup 🥅, the Olympics 🏅 -- A futbol ⚽️ autographed by a famous player -- A contribution to a charity +* First class airfare to GitHub offices for Executive Briefings ✈️+🍾 +* Winery tours 🍷 +* Recommending a friend’s kid to a prestigious private school for admission 🎓 +* Tickets to Disneyland 👸, the World Cup 🥅, the Olympics 🏅 +* A futbol ⚽️ autographed by a famous player +* A contribution to a charity 🙆 _Here is some stuff that is actually ok for customers or prospective customers:_ -- Swag -- Economy class airfare to GitHub offices for Executive Briefings ✈️ -- Bleacher-type tickets to a sporting event ⚾️ -- A reasonably priced dinner in town 🍽 -- A small box of chocolates as an end of year thank you 🍫 +* Swag +* Economy class airfare to GitHub offices for Executive Briefings ✈️ +* Bleacher-type tickets to a sporting event ⚾️ +* A reasonably priced dinner in town 🍽 +* A small box of chocolates as an end of year thank you 🍫 All of the above applies to _taking_ bribes too. So if a vendor or prospective vendor sends you something “of value,” don’t accept it—or at least run it by Legal before you do. @@ -59,8 +59,8 @@ Keep in mind that what's an acceptable amount can vary. For example, spending $5 1. Generally speaking, for any expenses exceeding $150, you'll need approval (each time) from Legal in writing. And for any gifts you receive exceeding $150, you'll need to report that (each time) to Legal in writing. (Legal is just weighing in on the bribery question. You might still need to check with Finance for other reasons.) 1. When you submit your expense report for reimbursement, please: - - Indicate the recipient and the purpose of the gift in the notes; and - - Include a copy of the email approval + * Indicate the recipient and the purpose of the gift in the notes; and + * Include a copy of the email approval ## Consequences diff --git a/content/site-policy/github-company-policies/github-statement-against-modern-slavery-and-child-labor.md b/content/site-policy/github-company-policies/github-statement-against-modern-slavery-and-child-labor.md index 2476b5fc5d24..e9eca2bfbfed 100644 --- a/content/site-policy/github-company-policies/github-statement-against-modern-slavery-and-child-labor.md +++ b/content/site-policy/github-company-policies/github-statement-against-modern-slavery-and-child-labor.md @@ -12,9 +12,9 @@ topics: _2018 statement_ According to the International Labour Organization (ILO), [40 million people were victims of modern slavery and 152 million children were subject to child labor](https://www.ilo.org/global/about-the-ilo/newsroom/news/WCMS_574717/lang--en/index.htm) globally in 2016. As the [ILO reports](https://www.ilo.org/global/topics/forced-labour/lang--en/index.htm): - - 1 in 4 victims of modern slavery are children. - - Out of the 24.9 million people trapped in forced labour, 16 million people are exploited in the private sector such as domestic work, construction or agriculture; 4.8 million persons in forced sexual exploitation, and 4 million persons in forced labour imposed by state authorities. - - Women and girls are disproportionately affected by forced labour, accounting for 99% of victims in the commercial sex industry, and 58% in other sectors. + * 1 in 4 victims of modern slavery are children. + * Out of the 24.9 million people trapped in forced labour, 16 million people are exploited in the private sector such as domestic work, construction or agriculture; 4.8 million persons in forced sexual exploitation, and 4 million persons in forced labour imposed by state authorities. + * Women and girls are disproportionately affected by forced labour, accounting for 99% of victims in the commercial sex industry, and 58% in other sectors. GitHub deplores the presence and persistence of modern slavery and child labor, and takes seriously its responsibility to ensure that neither modern slavery nor child labor takes place in its supply chain or in any part of its business. ("Modern slavery" in this statement refers to slavery, forced or compulsory labor, trafficking, servitude, and workers who are imprisoned, indentured, or bonded. "Child labor" refers to work performed by someone under 16 years of age, or under 14 for light work, provided it is not confined to periods that interfere with the child's schooling and not in conditions that interfere with the child's health or well-being.) @@ -29,10 +29,10 @@ All GitHub employees and individual independent contractors are voluntary and at GitHub does not conduct manufacturing or produce hardware, nor does GitHub use recruitment agencies for the kinds of services often performed by migrant workers. The nature of GitHub's business does not subject it to sudden changes in workload or pricing pressures, which often drive demand for practices that increase the risk of forced labor in supply chains, such as forced overtime. GitHub offers free and paid software and web-based software as a service to customers all over the world. GitHub's products include: - - GitHub.com: web-based collaboration and code-hosting platform - - GitHub Enterprise: on-premises collaboration and code hosting software - - Electron: framework for writing cross-platform desktop apps - - GitHub Desktop: desktop app for accessing GitHub.com and GitHub Enterprise + * GitHub.com: web-based collaboration and code-hosting platform + * GitHub Enterprise: on-premises collaboration and code hosting software + * Electron: framework for writing cross-platform desktop apps + * GitHub Desktop: desktop app for accessing GitHub.com and GitHub Enterprise GitHub's supply chain consists of goods and services for our products and operations including computing services, event planning, purchase of retail and promotional items, office supplies, and leasing of facilities such as office space and data centers. @@ -57,21 +57,21 @@ GitHub has a non-retaliation policy for reporting workplace-related concerns. Co GitHub's labor practices are **fair**: - - GitHub pays its employees and contractors a fair wage, in accordance with applicable legal wages - - GitHub maintains humane working conditions - - GitHub does not require workers to exceed the maximum hours of daily labor set by local and national laws or regulations - - GitHub pays its employees and contractors in a timely manner, with documentation (such as a pay stub) stating the basis on which they are paid, and keeps employee records in accordance with local and national laws + * GitHub pays its employees and contractors a fair wage, in accordance with applicable legal wages + * GitHub maintains humane working conditions + * GitHub does not require workers to exceed the maximum hours of daily labor set by local and national laws or regulations + * GitHub pays its employees and contractors in a timely manner, with documentation (such as a pay stub) stating the basis on which they are paid, and keeps employee records in accordance with local and national laws **humane and ethical**: - - GitHub uses only voluntary labor - - GitHub prohibits child labor - - GitHub does not engage in physical discipline or abuse - - GitHub does not tolerate harassment or unlawful discrimination in the workforce or workplace + * GitHub uses only voluntary labor + * GitHub prohibits child labor + * GitHub does not engage in physical discipline or abuse + * GitHub does not tolerate harassment or unlawful discrimination in the workforce or workplace **respectful**: - - GitHub protects its employees' rights to freedom of association and collective bargaining in accordance with legal requirements, including to post legal notices of employees' rights under the National Labor Relations Act - - GitHub provides benefits to employees at or in excess of levels expected in the industry - - GitHub encourages employees to report any workplace complaint and does not tolerate retaliation for reporting + * GitHub protects its employees' rights to freedom of association and collective bargaining in accordance with legal requirements, including to post legal notices of employees' rights under the National Labor Relations Act + * GitHub provides benefits to employees at or in excess of levels expected in the industry + * GitHub encourages employees to report any workplace complaint and does not tolerate retaliation for reporting ## Due diligence processes in relation to modern slavery and child labor in its business and supply chains @@ -88,17 +88,17 @@ Although GitHub knows of no actual or alleged modern slavery or child labor in i GitHub complies and will continue to comply with laws related to modern slavery and child labor. Going forward, GitHub now requires its suppliers to comply with this Statement, as well as laws related to modern slavery and child labor. GitHub now also requires its suppliers to: - - not use, participate in, support, or tolerate modern slavery or child labor - - not use misleading or fraudulent recruitment or engagement practices for employees or contract workers - - not charge employees or contract workers recruitment or engagement fees - - not destroy, conceal, confiscate, or otherwise deny access by an employee or any contract worker to passport, driver's license, or other identity documents; - - allow us to terminate our agreements with them for any violation of its obligations related to modern slavery or child labor; and - - remediate any harms caused to any worker found to be subjected to any form of modern slavery or child labor, if required by law. + * not use, participate in, support, or tolerate modern slavery or child labor + * not use misleading or fraudulent recruitment or engagement practices for employees or contract workers + * not charge employees or contract workers recruitment or engagement fees + * not destroy, conceal, confiscate, or otherwise deny access by an employee or any contract worker to passport, driver's license, or other identity documents; + * allow us to terminate our agreements with them for any violation of its obligations related to modern slavery or child labor; and + * remediate any harms caused to any worker found to be subjected to any form of modern slavery or child labor, if required by law. In addition, GitHub strongly encourages its suppliers to: - - conduct anti-modern slavery and child labor due diligence processes, including risk assessments, for their suppliers; - - take steps to address risks identified; and - - use similar anti-modern slavery and child labor language with their suppliers. + * conduct anti-modern slavery and child labor due diligence processes, including risk assessments, for their suppliers; + * take steps to address risks identified; and + * use similar anti-modern slavery and child labor language with their suppliers. GitHub's procurement instructions to employees making company purchases now includes a reference to the requirement for suppliers to comply with Microsoft's Supplier Code of Conduct or this Statement. diff --git a/content/site-policy/github-terms/github-community-code-of-conduct.md b/content/site-policy/github-terms/github-community-code-of-conduct.md index f5b43d1d6bed..ac5dd5fc4e68 100644 --- a/content/site-policy/github-terms/github-community-code-of-conduct.md +++ b/content/site-policy/github-terms/github-community-code-of-conduct.md @@ -36,58 +36,58 @@ The following are not hard and fast rules, merely aids to the human judgment of The primary purpose of the GitHub community is to collaborate on software projects. We are committed to maintaining a community where users are free to express themselves and challenge one another's ideas, both technical and otherwise. At the same time, it's important that users remain respectful and allow space for others to contribute openly. In order to foster both a safe and productive environment, we encourage our community members to look to these guidelines to inform how they interact on our platform. Below, you’ll find some suggestions for how to have successful interactions as a valued member of the GitHub community. -- Engage with consideration and respect. +* Engage with consideration and respect. - - **Be welcoming and open-minded** - New users join our community each day. Some are well-established developers, while others are just beginning. Be open to other ideas and experience levels. Make room for opinions other than your own and be welcoming to new collaborators and those just getting started. + * **Be welcoming and open-minded** - New users join our community each day. Some are well-established developers, while others are just beginning. Be open to other ideas and experience levels. Make room for opinions other than your own and be welcoming to new collaborators and those just getting started. - - **Be respectful** - Working in a collaborative environment means disagreements may happen. But remember to criticize ideas, not people. Share thoughtful, constructive criticism and be courteous to those you interact with. If you’re unable to engage respectfully, consider taking a step back or using some of our moderation tools to deescalate a tense situation. + * **Be respectful** - Working in a collaborative environment means disagreements may happen. But remember to criticize ideas, not people. Share thoughtful, constructive criticism and be courteous to those you interact with. If you’re unable to engage respectfully, consider taking a step back or using some of our moderation tools to deescalate a tense situation. - - **Be empathetic** - GitHub is a global community with people from a wide variety of backgrounds and perspectives, many of which may not be your own. Try to put yourself in others’ shoes and understand their feelings before you address them. Do your best to help make GitHub a community where others feel safe to make contributions, participate in discussions, and share different ideas. + * **Be empathetic** - GitHub is a global community with people from a wide variety of backgrounds and perspectives, many of which may not be your own. Try to put yourself in others’ shoes and understand their feelings before you address them. Do your best to help make GitHub a community where others feel safe to make contributions, participate in discussions, and share different ideas. -- Contribute in a positive and constructive way. - - **Improve the discussion.** Help us make this a great place for discussion by always working to improve the discussion in some way, however small. If you are not sure your post adds to the conversation, think over what you want to say and try again later. +* Contribute in a positive and constructive way. + * **Improve the discussion.** Help us make this a great place for discussion by always working to improve the discussion in some way, however small. If you are not sure your post adds to the conversation, think over what you want to say and try again later. The topics discussed here matter to us, and we want you to act as if they matter to you, too. Be respectful of the topics and the people discussing them, even if you disagree with some of what is being said. - - **Be clear and stay on topic.** GitHub Community is for collaboration, sharing ideas, and helping each other get stuff done. Off-topic comments are a distraction (sometimes welcome, but usually not) from getting work done and being productive. Staying on topic helps produce positive and productive discussions. + * **Be clear and stay on topic.** GitHub Community is for collaboration, sharing ideas, and helping each other get stuff done. Off-topic comments are a distraction (sometimes welcome, but usually not) from getting work done and being productive. Staying on topic helps produce positive and productive discussions. This applies to sharing links, as well. Any links shared in GitHub Community discussions should be shared with the intent of providing relevant and appropriate information. Links should not be posted to simply drive traffic or attention to a site. Links should always be accompanied by a full explanation of the content and purpose of the link. Posting links, especially unsolicited ones, without relevant and valuable context can come across as advertising or serving even more malicious purposes. - - **Share mindfully.** When asking others to give you feedback or collaborate on a project, only share valuable and relevant resources to provide context. Don't post links that don't add value to the discussion, and don't post unsolicited links to your own projects or sites on other user's threads. + * **Share mindfully.** When asking others to give you feedback or collaborate on a project, only share valuable and relevant resources to provide context. Don't post links that don't add value to the discussion, and don't post unsolicited links to your own projects or sites on other user's threads. Additionally, don't share sensitive information. This includes your own email address. We don't allow the sharing of such information in GitHub Community, as it can create security and privacy risks for the poster, as well as other users. If you'd like to invite other GitHub users to collaborate on a project or work with you, share a link to the repository in which the project you are working on exists. By sharing the link to your project repo - with some information on what your project is and what kind of help or feedback you're looking for - you can invite others to collaborate with you via issues or pull requests without having to share your private information. You can also add others as outside collaborators on your project repo to give them special permissions to help you develop your project. - - **Keep it tidy.** Make the effort to put things in the right place, so that we can spend more time discussing and less time cleaning up. So: - - Don’t start a discussion in the wrong category. - - Don’t cross-post the same thing in multiple discussions. - - Don’t post no-content replies. - - Don't "bump" posts, unless you have new and relevant information to share. - - Don’t divert a discussion by changing it midstream. + * **Keep it tidy.** Make the effort to put things in the right place, so that we can spend more time discussing and less time cleaning up. So: + * Don’t start a discussion in the wrong category. + * Don’t cross-post the same thing in multiple discussions. + * Don’t post no-content replies. + * Don't "bump" posts, unless you have new and relevant information to share. + * Don’t divert a discussion by changing it midstream. Rather than posting “+1” or “Agreed”, use the upvote button. Rather than taking an existing discussion in a radically different direction, open a new discussion. -- Be trustworthy. - - **Always be honest.** Don’t knowingly share incorrect information or intentionally mislead other GitHub Community participants. If you don’t know the answer to someone’s question but still want to help, you can try helping them research or find resources instead. GitHub staff will also be active in GitHub Community, so if you’re unsure of an answer, it’s likely a moderator will be able to help. +* Be trustworthy. + * **Always be honest.** Don’t knowingly share incorrect information or intentionally mislead other GitHub Community participants. If you don’t know the answer to someone’s question but still want to help, you can try helping them research or find resources instead. GitHub staff will also be active in GitHub Community, so if you’re unsure of an answer, it’s likely a moderator will be able to help. ### _What is not Allowed_ GitHub's [Acceptable Use Policies](/site-policy/acceptable-use-policies/github-acceptable-use-policies), which are part of GitHub's [Terms of Service](/site-policy/github-terms/github-terms-of-service), set a baseline for what is not allowed on GitHub. Since GitHub Community is on GitHub.com, these terms and restrictions apply to GitHub Community, including the following restrictions: -- **Anyone under the age of 13.** If you're a child under the age of 13, you may not have an account on GitHub. GitHub does not knowingly collect information from or direct any of our content specifically to children under 13. If we learn or have reason to suspect that you are a user who is under the age of 13, we will unfortunately have to close your GitHub.com account. We don't want to discourage you from learning to code, but those are the rules. Please see our [Terms of Service](/site-policy/github-terms/github-terms-of-service) for information about account termination. +* **Anyone under the age of 13.** If you're a child under the age of 13, you may not have an account on GitHub. GitHub does not knowingly collect information from or direct any of our content specifically to children under 13. If we learn or have reason to suspect that you are a user who is under the age of 13, we will unfortunately have to close your GitHub.com account. We don't want to discourage you from learning to code, but those are the rules. Please see our [Terms of Service](/site-policy/github-terms/github-terms-of-service) for information about account termination. -- **Creating new account after account restriction.** GitHub's [Terms of Service](/site-policy/github-terms/github-terms-of-service) state that "One person or legal entity may maintain no more than one free Account." Additional free accounts created to inquire about flagged or suspended accounts in GitHub will be removed. +* **Creating new account after account restriction.** GitHub's [Terms of Service](/site-policy/github-terms/github-terms-of-service) state that "One person or legal entity may maintain no more than one free Account." Additional free accounts created to inquire about flagged or suspended accounts in GitHub will be removed. -- **Other conduct which could reasonably be considered inappropriate in a professional setting.** GitHub Community is a professional space and should be treated as such. +* **Other conduct which could reasonably be considered inappropriate in a professional setting.** GitHub Community is a professional space and should be treated as such. -- **Violation of Terms of Service.** If your GitHub.com account is identified in violation of [Terms of Service](/site-policy/github-terms/github-terms-of-service) we will have to close your account. +* **Violation of Terms of Service.** If your GitHub.com account is identified in violation of [Terms of Service](/site-policy/github-terms/github-terms-of-service) we will have to close your account. ### _Reasonable use of AI generated content_ We love experimenting with new technologies, and we are especially fond of [GitHub Copilot](https://github.com/features/copilot). But as with all new technology, many of us are still getting accustomed to using generative AI tools the most effectively. Here are important guidelines to follow when using generative AI to answer questions in the community: - - Take personal responsibility for everything you post. - - Read and revise the content before you post it; use your own authentic voice. - - Use your expertise as a developer to verify that the answer works and makes sense. - - Do not just post AI-generated content verbatim to inflate your reputation or give a false impression of product expertise. - - AI tools will often answer in an authoritative tone that sounds like a tech support professional. Be careful not to [mislead other users](/site-policy/acceptable-use-policies/github-impersonation) into thinking that this authoritative tone means they are receiving an official response from GitHub. + * Take personal responsibility for everything you post. + * Read and revise the content before you post it; use your own authentic voice. + * Use your expertise as a developer to verify that the answer works and makes sense. + * Do not just post AI-generated content verbatim to inflate your reputation or give a false impression of product expertise. + * AI tools will often answer in an authoritative tone that sounds like a tech support professional. Be careful not to [mislead other users](/site-policy/acceptable-use-policies/github-impersonation) into thinking that this authoritative tone means they are receiving an official response from GitHub. Additionally, all of the guidelines listed in the previous section ([Best Practices for Maintaining a Strong Community](/site-policy/github-terms/github-community-code-of-conduct#best-practices-for-maintaining-a-strong-community)) also apply here. @@ -97,7 +97,7 @@ The community is here for users to build trust through authentic reputations. No ### _What GitHub Community Participants Can Do_ -- **If you see a problem, report it.** Moderators have special authority; they are responsible for this GitHub Community. But so are you. With your help, moderators can be community facilitators, not just janitors or police. +* **If you see a problem, report it.** Moderators have special authority; they are responsible for this GitHub Community. But so are you. With your help, moderators can be community facilitators, not just janitors or police. When you see bad behavior, don’t reply. It encourages the bad behavior by acknowledging it, consumes your energy, and wastes everyone’s time. You can report a disruptive user or disruptive content to GitHub. For more information, see "[AUTOTITLE](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)." @@ -108,10 +108,10 @@ There are a variety of actions that we may take in response to inappropriate beh Each case requires a different approach, and we try to tailor our response to meet the needs of the situation. We'll review each situation on a case-by-case basis. In each case, we will have a diverse team investigate the content and surrounding facts and respond as appropriate, using this Code of Conduct to guide our decision. Actions we may take in response to a flag or abuse report include, but are not limited to: - - Content Removal - - Content Blocking - - GitHub Account Suspension - - GitHub Account Termination + * Content Removal + * Content Blocking + * GitHub Account Suspension + * GitHub Account Termination GitHub Community moderators who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the GitHub Community's leadership. diff --git a/content/site-policy/github-terms/github-community-guidelines.md b/content/site-policy/github-terms/github-community-guidelines.md index a421efdad511..c6fb9310296d 100644 --- a/content/site-policy/github-terms/github-community-guidelines.md +++ b/content/site-policy/github-terms/github-community-guidelines.md @@ -24,25 +24,25 @@ We encourage our community members to communicate expectations clearly, [moderat The primary purpose of the GitHub community is to collaborate on software projects. We are committed to maintaining a community where users are free to express themselves and challenge one another's ideas, both technical and otherwise. At the same time, it's important that users remain respectful and allow space for others to contribute openly. In order to foster both a safe and productive environment, we encourage our community members to look to these guidelines to inform how they interact on our platform. Below, you’ll find some suggestions for how to have successful interactions as a valued member of the GitHub community. -- **Be welcoming and open-minded** - New users join our community each day. Some are well-established developers, while others are just beginning. Be open to other ideas and experience levels. Make room for opinions other than your own and be welcoming to new collaborators and those just getting started. +* **Be welcoming and open-minded** - New users join our community each day. Some are well-established developers, while others are just beginning. Be open to other ideas and experience levels. Make room for opinions other than your own and be welcoming to new collaborators and those just getting started. -- **Be respectful** - Working in a collaborative environment means disagreements may happen. But remember to criticize ideas, not people. Share thoughtful, constructive criticism and be courteous to those you interact with. If you’re unable to engage respectfully, consider taking a step back or using some of our moderation tools to deescalate a tense situation. +* **Be respectful** - Working in a collaborative environment means disagreements may happen. But remember to criticize ideas, not people. Share thoughtful, constructive criticism and be courteous to those you interact with. If you’re unable to engage respectfully, consider taking a step back or using some of our moderation tools to deescalate a tense situation. -- **Be empathetic** - GitHub is a global community with people from a wide variety of backgrounds and perspectives, many of which may not be your own. Try to put yourself in others’ shoes and understand their feelings before you address them. Do your best to help make GitHub a community where others feel safe to make contributions, participate in discussions, and share different ideas. +* **Be empathetic** - GitHub is a global community with people from a wide variety of backgrounds and perspectives, many of which may not be your own. Try to put yourself in others’ shoes and understand their feelings before you address them. Do your best to help make GitHub a community where others feel safe to make contributions, participate in discussions, and share different ideas. ## What if something or someone offends you? While some disagreements can be resolved with direct, respectful communication between community members, we understand that is not always the case. We encourage our community to contact GitHub Support through the [GitHub Support portal](https://support.github.com/) when they believe content or activity they’ve encountered violates our policies. However, if you run into something or someone on the site that you find objectionable, here are some ways GitHub enables you to take action: -- **Communicate expectations** - Maintainers can set community-specific guidelines to help users understand how to interact with their projects, for example, in a repository’s README, [CONTRIBUTING file](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors), or [dedicated code of conduct](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project). You can find additional information on building communities on the [Communities](/communities) page. +* **Communicate expectations** - Maintainers can set community-specific guidelines to help users understand how to interact with their projects, for example, in a repository’s README, [CONTRIBUTING file](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors), or [dedicated code of conduct](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project). You can find additional information on building communities on the [Communities](/communities) page. -- **Moderate Comments** - Users with [write-access privileges](/organizations/managing-user-access-to-your-organizations-repositories/repository-roles-for-an-organization) for a repository can [edit, delete, or hide anyone's comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments) on commits, pull requests, and issues. Anyone with read access to a repository can view a comment's edit history. Comment authors and people with write access to a repository can also delete sensitive information from a [comment's edit history](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment). Moderating your projects can feel like a big task if there is a lot of activity, but you can [add collaborators](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository#collaborator-access-for-a-repository-owned-by-a-personal-account) to assist you in managing your community. +* **Moderate Comments** - Users with [write-access privileges](/organizations/managing-user-access-to-your-organizations-repositories/repository-roles-for-an-organization) for a repository can [edit, delete, or hide anyone's comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments) on commits, pull requests, and issues. Anyone with read access to a repository can view a comment's edit history. Comment authors and people with write access to a repository can also delete sensitive information from a [comment's edit history](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment). Moderating your projects can feel like a big task if there is a lot of activity, but you can [add collaborators](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository#collaborator-access-for-a-repository-owned-by-a-personal-account) to assist you in managing your community. -- **Lock Conversations**  - If a discussion in an issue, pull request, or commit gets out of hand, off topic, or violates your project’s code of conduct or GitHub’s policies, owners, collaborators, and anyone else with write access can put a temporary or permanent lock on the conversation. For more information, see "[AUTOTITLE](/communities/moderating-comments-and-conversations/locking-conversations)." +* **Lock Conversations**  - If a discussion in an issue, pull request, or commit gets out of hand, off topic, or violates your project’s code of conduct or GitHub’s policies, owners, collaborators, and anyone else with write access can put a temporary or permanent lock on the conversation. For more information, see "[AUTOTITLE](/communities/moderating-comments-and-conversations/locking-conversations)." -- **Block Users**  - If you encounter a specific user who you would rather not engage with, you can [block the user from your personal account](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account) or [from your organization](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization). +* **Block Users**  - If you encounter a specific user who you would rather not engage with, you can [block the user from your personal account](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account) or [from your organization](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization). -- **Limit Interactions** - If your public project is getting unwanted attention, being trolled, spammed, or otherwise, you have the option of setting [temporary interaction limits](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository) to keep certain users from interacting with your repository. You can even set [code review limits](https://github.blog/2021-11-01-github-keeps-getting-better-for-open-source-maintainers/#preventing-drive-by-pull-request-approvals-and-requested-changes) to ensure quality contributions on your projects. +* **Limit Interactions** - If your public project is getting unwanted attention, being trolled, spammed, or otherwise, you have the option of setting [temporary interaction limits](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository) to keep certain users from interacting with your repository. You can even set [code review limits](https://github.blog/2021-11-01-github-keeps-getting-better-for-open-source-maintainers/#preventing-drive-by-pull-request-approvals-and-requested-changes) to ensure quality contributions on your projects. While we are passionate about empowering maintainers to moderate their own projects, please contact {% data variables.contact.contact_support %} if you need additional support in dealing with a situation. @@ -50,19 +50,19 @@ While we are passionate about empowering maintainers to moderate their own proje We rely on reports from the community, as well as proactive detection, to help ensure that GitHub is a safe, welcoming, and productive platform for software developers. There are a variety of factors we consider when we’re made aware of behavior or content not in line with GitHub’s policies. However, our policy enforcement and content moderation approach prioritizes our vision to be the home for all developers. This means: -- We optimize for code collaboration. We recognize that code can have multiple uses and we distinguish between how the code is being used on the platform and other possible uses. We also think about how our enforcement actions can affect a potentially complicated web of interdependencies across the platform and aim to restrict as little legitimate content as possible. +* We optimize for code collaboration. We recognize that code can have multiple uses and we distinguish between how the code is being used on the platform and other possible uses. We also think about how our enforcement actions can affect a potentially complicated web of interdependencies across the platform and aim to restrict as little legitimate content as possible. -- We take a human-centered approach to content moderation and we tailor our responses to meet the needs of a specific situation. Our global team investigates the reports we receive on a case-by-case basis—considering context and the surrounding facts—before taking action. This could include taking into account potentially offensive content being posted in a way that lacks context or makes it easy for other users to unwittingly view or interact with while using GitHub. In those instances, we may favor moderation in order to safeguard our community. +* We take a human-centered approach to content moderation and we tailor our responses to meet the needs of a specific situation. Our global team investigates the reports we receive on a case-by-case basis—considering context and the surrounding facts—before taking action. This could include taking into account potentially offensive content being posted in a way that lacks context or makes it easy for other users to unwittingly view or interact with while using GitHub. In those instances, we may favor moderation in order to safeguard our community. -- Our decisions are rooted in our core belief that serving an interconnected community and empowering human progress through developer collaboration requires a commitment to diversity, inclusion, and belonging. +* Our decisions are rooted in our core belief that serving an interconnected community and empowering human progress through developer collaboration requires a commitment to diversity, inclusion, and belonging. Where we have decided that moderation action is warranted, these are some of the ways we may respond: -- Removing the offending content -- Blocking or disabling the offending content -- Downgrading the visibility of the offending content -- Hiding a user account or organization from public view -- Suspending a user account or organization +* Removing the offending content +* Blocking or disabling the offending content +* Downgrading the visibility of the offending content +* Hiding a user account or organization from public view +* Suspending a user account or organization ## Appeal and Reinstatement diff --git a/content/site-policy/github-terms/github-corporate-terms-of-service.md b/content/site-policy/github-terms/github-corporate-terms-of-service.md index 98e6c9af0c0f..0a46740e5381 100644 --- a/content/site-policy/github-terms/github-corporate-terms-of-service.md +++ b/content/site-policy/github-terms/github-corporate-terms-of-service.md @@ -22,10 +22,10 @@ topics: Version Effective Date: November 16, 2020 This Agreement applies to the following GitHub offerings, as further defined below (collectively, the **“Products”**): -- The Service; -- Any Beta Previews; -- Any related Support; and -- Any related Professional Services. +* The Service; +* Any Beta Previews; +* Any related Support; and +* Any related Professional Services. ## A. Definitions @@ -97,19 +97,19 @@ This Agreement applies to the following GitHub offerings, as further defined bel ### 1. Account Controls. -- _Users._ Customer acknowledges that Users retain ultimate administrative control over their individual accounts and the Content within them. [GitHub's Standard Terms of Service](/site-policy/github-terms/github-terms-of-service) govern Users' use of the Service, except with respect to Users' activities under this Section B. +* _Users._ Customer acknowledges that Users retain ultimate administrative control over their individual accounts and the Content within them. [GitHub's Standard Terms of Service](/site-policy/github-terms/github-terms-of-service) govern Users' use of the Service, except with respect to Users' activities under this Section B. -- _Organizations._ Customer retains ultimate administrative control over any Organization created on Customer’s behalf and User-Generated Content posted to the repositories within its Organization(s), subject to this Section B. This Section B will govern the use of Customer’s Organization(s). +* _Organizations._ Customer retains ultimate administrative control over any Organization created on Customer’s behalf and User-Generated Content posted to the repositories within its Organization(s), subject to this Section B. This Section B will govern the use of Customer’s Organization(s). ### 2. Account Requirements In order to create an account, Customer must adhere to the following: -- Customer must not create an account for use of any person under the age of 13. If GitHub learns of any User under the age of 13, it will terminate that User's account immediately. If Customer or its User(s) are located in a country outside the United States, that country's minimum age may be older; in such a case, Customer is responsible for complying with that country's laws. +* Customer must not create an account for use of any person under the age of 13. If GitHub learns of any User under the age of 13, it will terminate that User's account immediately. If Customer or its User(s) are located in a country outside the United States, that country's minimum age may be older; in such a case, Customer is responsible for complying with that country's laws. -- A User’s login may not be shared by multiple people. +* A User’s login may not be shared by multiple people. -- Customer must not use the Products (a) in violation of export control or sanctions laws of the United States or any other applicable jurisdiction; (b) if it is located in or ordinarily resident in a country or territory subject to comprehensive sanctions administered by the U.S. Office of Foreign Assets Control (OFAC); or (c) if it is or is working on behalf of a [Specially Designated National (SDN)](https://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx) or a person subject to similar blocking or denied party prohibitions. For more information, please see our [Export Controls policy](/site-policy/other-site-policies/github-and-trade-controls). +* Customer must not use the Products (a) in violation of export control or sanctions laws of the United States or any other applicable jurisdiction; (b) if it is located in or ordinarily resident in a country or territory subject to comprehensive sanctions administered by the U.S. Office of Foreign Assets Control (OFAC); or (c) if it is or is working on behalf of a [Specially Designated National (SDN)](https://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx) or a person subject to similar blocking or denied party prohibitions. For more information, please see our [Export Controls policy](/site-policy/other-site-policies/github-and-trade-controls). ### 3. Account Security @@ -255,11 +255,11 @@ Either Party may terminate this Agreement immediately upon notice if the other P ### 4. Effect of Termination -- _Order Forms._ Upon termination of this Agreement, Customer may not execute additional Order Forms (if applicable); however, this Agreement will remain in effect for the remainder of any active Order Forms. When an Order Form terminates or expires, as to that Order Form: (i) the Term will immediately end; (ii) any Subscription Licenses in the Order Form will automatically terminate, and Customer will no longer have the right to use the Service; (iii) if any Fees were owed prior to termination, Customer must pay those Fees immediately; (iv) each Party will promptly return (or, if the other party requests it, destroy) all Confidential Information belonging to the other to the extent permitted by the Service. Notwithstanding the foregoing, GitHub will make a reasonable effort to provide Customer with a copy of its lawful, non-infringing account Contents upon request; provided that Customer makes this request within 90 days of termination, suspension, or downgrade. +* _Order Forms._ Upon termination of this Agreement, Customer may not execute additional Order Forms (if applicable); however, this Agreement will remain in effect for the remainder of any active Order Forms. When an Order Form terminates or expires, as to that Order Form: (i) the Term will immediately end; (ii) any Subscription Licenses in the Order Form will automatically terminate, and Customer will no longer have the right to use the Service; (iii) if any Fees were owed prior to termination, Customer must pay those Fees immediately; (iv) each Party will promptly return (or, if the other party requests it, destroy) all Confidential Information belonging to the other to the extent permitted by the Service. Notwithstanding the foregoing, GitHub will make a reasonable effort to provide Customer with a copy of its lawful, non-infringing account Contents upon request; provided that Customer makes this request within 90 days of termination, suspension, or downgrade. -- GitHub will retain and use Customer's information as necessary to comply with our legal obligations, resolve disputes, and enforce GitHub's agreements, but barring legal requirements, GitHub will delete Customer's full profile and the Content of its repositories within 90 days of termination or expiration (though some information may remain in encrypted backups). This information cannot be recovered once Customer's account is canceled. +* GitHub will retain and use Customer's information as necessary to comply with our legal obligations, resolve disputes, and enforce GitHub's agreements, but barring legal requirements, GitHub will delete Customer's full profile and the Content of its repositories within 90 days of termination or expiration (though some information may remain in encrypted backups). This information cannot be recovered once Customer's account is canceled. -- GitHub will not delete Content that Customer has contributed to External Users' repositories or that External Users have forked. +* GitHub will not delete Content that Customer has contributed to External Users' repositories or that External Users have forked. ### 5. Suspension diff --git a/content/site-policy/github-terms/github-event-code-of-conduct.md b/content/site-policy/github-terms/github-event-code-of-conduct.md index 3a8b55fb4524..29580502b866 100644 --- a/content/site-policy/github-terms/github-event-code-of-conduct.md +++ b/content/site-policy/github-terms/github-event-code-of-conduct.md @@ -22,23 +22,23 @@ We do not tolerate harassment of Event Participants in any form, nor do we toler Examples of encouraged behavior that contributes to a positive environment include: -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for everyone at the Event -- Showing empathy towards others and Event Participants +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for everyone at the Event +* Showing empathy towards others and Event Participants Unacceptable behavior includes, but is not limited to: -- The use of sexualized language or imagery -- Inappropriate physical contact, sexual attention, or advances -- Trolling, insulting or derogatory comments or behavior -- Personal or political attacks toward Event Participants -- Sustained disruption of talks or any other events or activities organized by GitHub in association with the Event -- Intimidation, stalking, following, or harassing of Event Participants -- Photography or recording of Event Participants without their consent -- Harassment of any kind, even in a joking or ironic manner -- Conduct which could reasonably be considered inappropriate in a professional setting +* The use of sexualized language or imagery +* Inappropriate physical contact, sexual attention, or advances +* Trolling, insulting or derogatory comments or behavior +* Personal or political attacks toward Event Participants +* Sustained disruption of talks or any other events or activities organized by GitHub in association with the Event +* Intimidation, stalking, following, or harassing of Event Participants +* Photography or recording of Event Participants without their consent +* Harassment of any kind, even in a joking or ironic manner +* Conduct which could reasonably be considered inappropriate in a professional setting Each Event Participant is entirely responsible for their own actions. diff --git a/content/site-policy/github-terms/github-event-terms.md b/content/site-policy/github-terms/github-event-terms.md index 28c34aef104a..972c01078b8d 100644 --- a/content/site-policy/github-terms/github-event-terms.md +++ b/content/site-policy/github-terms/github-event-terms.md @@ -16,10 +16,10 @@ By RSVP'ing to or attending a GitHub event, including any of the events or activ In order to participate in the Event, you represent that -- You have the requisite capacity and authority to enter into these Event Terms; -- You have read and understood these Event Terms and the [AUTOTITLE](/site-policy/github-terms/github-terms-of-service); -- You agree to abide by the [Event Code of Conduct](/site-policy/github-terms/github-event-code-of-conduct); and -- If alcohol is being served at the Event, you are at least 21 years old or over the legal drinking age at the location where the Event is being held. +* You have the requisite capacity and authority to enter into these Event Terms; +* You have read and understood these Event Terms and the [AUTOTITLE](/site-policy/github-terms/github-terms-of-service); +* You agree to abide by the [Event Code of Conduct](/site-policy/github-terms/github-event-code-of-conduct); and +* If alcohol is being served at the Event, you are at least 21 years old or over the legal drinking age at the location where the Event is being held. If asked to stop behavior deemed harassing or prohibited, you must comply immediately. If you violate the [Event Code of Conduct](/site-policy/github-terms/github-event-code-of-conduct) or these Event Terms, the Event organizers may take any action they deem appropriate in their discretion, including warnings or expulsion from the Event with no refund. You must at all times obey the instructions or directions of the Event organizers. diff --git a/content/site-policy/github-terms/github-marketplace-developer-agreement.md b/content/site-policy/github-terms/github-marketplace-developer-agreement.md index da95c3c9a96d..e325234e6f62 100644 --- a/content/site-policy/github-terms/github-marketplace-developer-agreement.md +++ b/content/site-policy/github-terms/github-marketplace-developer-agreement.md @@ -65,26 +65,26 @@ Notwithstanding any of the requirements set forth in Section 2 (Purpose and Lice **3.3** Developer will not engage in any activity with Marketplace, including attempting to distribute any Developer Product, that violates GitHub's Terms of Service including [Acceptable Use Policies](https://docs.github.com/en/site-policy/acceptable-use-policies/github-acceptable-use-policies). Additionally, Developer will not attempt to distribute any Developer Product that: -- 1\. Contains or installs any active malware or exploits, or uses our platform for exploit delivery (such as part of a command and control system); -- 2\. Enables the unauthorized download of streaming content or media; or -- 3\. Diverts End Users or provides links to any other site that mimics Marketplace or passes itself off as Marketplace +* 1\. Contains or installs any active malware or exploits, or uses our platform for exploit delivery (such as part of a command and control system); +* 2\. Enables the unauthorized download of streaming content or media; or +* 3\. Diverts End Users or provides links to any other site that mimics Marketplace or passes itself off as Marketplace **3.4** With respect to Developer Products that interact with generative AI technology, including GitHub Copilot Extensions, Developer will: -- 1\. Test the Developer Product using various inputs to ensure that outputs do not violate this Agreement; -- 2\. Notify users when they are interacting with generative AI content; -- 3\. Have a mechanism for End Users to report feedback to GitHub and Developer related to errors, bugs, improper, or undesired outputs; and -- 4\. Inform End Users the appropriate use cases, best practices, and limitations of the Developer Product. +* 1\. Test the Developer Product using various inputs to ensure that outputs do not violate this Agreement; +* 2\. Notify users when they are interacting with generative AI content; +* 3\. Have a mechanism for End Users to report feedback to GitHub and Developer related to errors, bugs, improper, or undesired outputs; and +* 4\. Inform End Users the appropriate use cases, best practices, and limitations of the Developer Product. **3.5** Developer shall not by any means repackage or resell Marketplace, a GitHub API, Personal Data, or Usage Data. Developer is not permitted to use a GitHub API or any Personal Data or Usage Data in any manner that does or could undermine the security of the Service, a GitHub API, Usage Data or any other data or information stored or transmitted using Marketplace. In addition, Developer shall not (a) interfere with, modify or disable any features, functionality or security controls of Marketplace or a GitHub API; (b) circumvent in any fashion any protection mechanisms for Marketplace or a GitHub API; or (c) reverse engineer, decompile, disassemble or derive the source code, underlying ideas, algorithms, structure or organizational form from Marketplace or a GitHub API. **3.6** Developer acknowledges that Developer is solely responsible, and that GitHub has no responsibility or liability of any kind, for any aspect of Developer Products. Developer will be solely responsible for: -- (i) providing End Users instructions on installing and using its Developer Products; -- (ii) creating and displaying information and content on, through or within its Developer Products; -- (iii) ensuring that its Developer Products do not violate or infringe the intellectual property rights of any third party; -- (iv) ensuring that Developer Products are not offensive, profane, obscene, libelous or otherwise illegal; -- (v) ensuring that its Developer Products do not contain or introduce malicious software into Marketplace, a GitHub API, any Usage Data or other data stored or transmitted using Marketplace; and -- (vi) ensuring that its Developer Products are not designed to or utilized for the purpose of sending commercial electronic messages to any GitHub.com users, agents or End Users without their consent. +* (i) providing End Users instructions on installing and using its Developer Products; +* (ii) creating and displaying information and content on, through or within its Developer Products; +* (iii) ensuring that its Developer Products do not violate or infringe the intellectual property rights of any third party; +* (iv) ensuring that Developer Products are not offensive, profane, obscene, libelous or otherwise illegal; +* (v) ensuring that its Developer Products do not contain or introduce malicious software into Marketplace, a GitHub API, any Usage Data or other data stored or transmitted using Marketplace; and +* (vi) ensuring that its Developer Products are not designed to or utilized for the purpose of sending commercial electronic messages to any GitHub.com users, agents or End Users without their consent. **3.7** Developer will respect and comply with the technical and policy-implemented limitations of a GitHub API and the restrictions of this Agreement in designing and implementing Developer Products. Developer shall not violate any explicit rate limitations on calling or otherwise utilizing a GitHub API. @@ -98,10 +98,10 @@ Notwithstanding any of the requirements set forth in Section 2 (Purpose and Lice If GitHub is notified by you or otherwise becomes aware and determines, in its sole discretion, that a Listing or any portion thereof or your Brand Features: -- (a) violates the terms of this Agreement or the ToS; -- (b) the display of the Listing is impacting the integrity of GitHub servers (i.e., users are unable to access such content or otherwise experience difficulty); -- (c) is deemed by GitHub to add undue risk to Marketplace End Users’ data or impair the user experience of Marketplace or GitHub; or -- (d) is subject to End User complaints in regards to your breach of your EULA, +* (a) violates the terms of this Agreement or the ToS; +* (b) the display of the Listing is impacting the integrity of GitHub servers (i.e., users are unable to access such content or otherwise experience difficulty); +* (c) is deemed by GitHub to add undue risk to Marketplace End Users’ data or impair the user experience of Marketplace or GitHub; or +* (d) is subject to End User complaints in regards to your breach of your EULA, GitHub may: suspend the transfer of Personal Data to your Developer Product; prohibit the collection and processing of Personal Data via your Developer Product; remove the Listing from Marketplace; flag, filter, or modify related materials (including but not limited to descriptions, screenshots, or metadata); or reclassify the Listing at its sole discretion. If GitHub takes any of these actions on your Listing, you may appeal GitHub's action through the [GitHub Appeal and Reinstatement Process](https://docs.github.com/en/site-policy/acceptable-use-policies/github-appeal-and-reinstatement) @@ -112,9 +112,9 @@ GitHub may: suspend the transfer of Personal Data to your Developer Product; pro ## 5. REPRESENTATIONS, WARRANTIES AND COVENANTS **5.1** Developer must inform End Users of the Personal Data that will be transmitted to the Developer Application from the Service and that Developer terms will control the privacy, security or integrity of such Personal Data. To the extent Developer’s Applications store, process or transmit Personal Data, neither Developer nor Developer’s Application will, without appropriate prior user consent or except to the extent required by applicable law, -- (i) modify the content of Personal Data in a manner that adversely affects the integrity of the Personal Data; -- (ii) disclose the Personal Data to any third party; or -- (iii) use the Personal Data for any purpose other than providing the Developer Application functionality to users of such Developer Application. +* (i) modify the content of Personal Data in a manner that adversely affects the integrity of the Personal Data; +* (ii) disclose the Personal Data to any third party; or +* (iii) use the Personal Data for any purpose other than providing the Developer Application functionality to users of such Developer Application. Developer shall maintain and handle all Personal Data in accordance with privacy and security measures reasonably adequate to preserve the confidentiality and security of all such Personal Data and all applicable privacy laws and regulations. @@ -206,34 +206,34 @@ GitHub maintains Personal Data from individuals all over the world, some of whom **A1-2. Definitions** -- (a) “Applicable Data Protection Laws” means any laws, regulations, regulatory frameworks, or other legislations relating to the processing and use of Personal Data, as applicable to the Agreement, including: - - The EU General Data Protection Regulation 2016/679 (“GDPR”), along with any implementing or corresponding equivalent national laws or regulations; - - The California Consumer Privacy Act of 2018, Cal. Civ. Code §§1798.100 et seq. ("CCPA"); and - - The UK Data Protection Act 2018 and implementation of GDPR contained therein. -- (b) “Personal Data” means any information which relates to an individual GitHub End User, customer or employee which could, alone or together with other information, identify them, whether supplied by GitHub for processing by the Developer or whether generated by the Developer in the course of performing its obligations under this Agreement. -- (c) “Processing” means any operation or set of operations performed on Personal Data, whether by manual or automatic means, including collection, recording, organization, storage, adaptation, alteration, retrieval, consultation, use, disclosure by transmission, dissemination or otherwise making available, blocking, erasure, or destruction. +* (a) “Applicable Data Protection Laws” means any laws, regulations, regulatory frameworks, or other legislations relating to the processing and use of Personal Data, as applicable to the Agreement, including: + * The EU General Data Protection Regulation 2016/679 (“GDPR”), along with any implementing or corresponding equivalent national laws or regulations; + * The California Consumer Privacy Act of 2018, Cal. Civ. Code §§1798.100 et seq. ("CCPA"); and + * The UK Data Protection Act 2018 and implementation of GDPR contained therein. +* (b) “Personal Data” means any information which relates to an individual GitHub End User, customer or employee which could, alone or together with other information, identify them, whether supplied by GitHub for processing by the Developer or whether generated by the Developer in the course of performing its obligations under this Agreement. +* (c) “Processing” means any operation or set of operations performed on Personal Data, whether by manual or automatic means, including collection, recording, organization, storage, adaptation, alteration, retrieval, consultation, use, disclosure by transmission, dissemination or otherwise making available, blocking, erasure, or destruction. **A1-3. Compliance with Data Transfer Laws** -- (a) GitHub Compliance. GitHub complies with Applicable Data Protection Laws. GitHub relies on Standard Contractual Clauses ("SCCs") for all transfers out of the European Union, European Economic Area, United Kingdom, and Switzerland to provide its services. GitHub also complies with the EU-U.S. Data Privacy Framework (EU-U.S. DPF), the UK Extension to the EU-U.S. DPF, and the Swiss-U.S. Data Privacy Framework (Swiss-U.S. DPF) as set forth by the U.S. Department of Commerce. GitHub has certified to the U.S. Department of Commerce that it adheres to the EU-U.S. Data Privacy Framework Principles (EU-U.S. DPF Principles) with regard to the processing of Personal Data received from the European Union in reliance on the EU-U.S. DPF and from the United Kingdom (and Gibraltar) in reliance on the UK Extension to the EU-U.S. DPF. GitHub has certified to the U.S. Department of Commerce that it adheres to the Swiss-U.S. Data Privacy Framework Principles (Swiss-U.S. DPF Principles) with regard to the processing of Personal Data received from Switzerland in reliance on the Swiss-U.S. DPF. -- (b) Developer Compliance. Developer represents and warrants that it will (i) comply with Applicable Data Protection Laws; and (ii) abide by the requirements of European Economic Area and Swiss data protection laws regarding the collection, use, transfer, retention, and other processing of Personal Data from the European Economic Area, United Kingdom, and Switzerland. All transfers of Personal Data to a third country or an international organization will be subject to appropriate safeguards as described in Article 46 of the GDPR and such transfers and safeguards will be documented according to Article 30(2) of the GDPR. +* (a) GitHub Compliance. GitHub complies with Applicable Data Protection Laws. GitHub relies on Standard Contractual Clauses ("SCCs") for all transfers out of the European Union, European Economic Area, United Kingdom, and Switzerland to provide its services. GitHub also complies with the EU-U.S. Data Privacy Framework (EU-U.S. DPF), the UK Extension to the EU-U.S. DPF, and the Swiss-U.S. Data Privacy Framework (Swiss-U.S. DPF) as set forth by the U.S. Department of Commerce. GitHub has certified to the U.S. Department of Commerce that it adheres to the EU-U.S. Data Privacy Framework Principles (EU-U.S. DPF Principles) with regard to the processing of Personal Data received from the European Union in reliance on the EU-U.S. DPF and from the United Kingdom (and Gibraltar) in reliance on the UK Extension to the EU-U.S. DPF. GitHub has certified to the U.S. Department of Commerce that it adheres to the Swiss-U.S. Data Privacy Framework Principles (Swiss-U.S. DPF Principles) with regard to the processing of Personal Data received from Switzerland in reliance on the Swiss-U.S. DPF. +* (b) Developer Compliance. Developer represents and warrants that it will (i) comply with Applicable Data Protection Laws; and (ii) abide by the requirements of European Economic Area and Swiss data protection laws regarding the collection, use, transfer, retention, and other processing of Personal Data from the European Economic Area, United Kingdom, and Switzerland. All transfers of Personal Data to a third country or an international organization will be subject to appropriate safeguards as described in Article 46 of the GDPR and such transfers and safeguards will be documented according to Article 30(2) of the GDPR. **A1-4. Data Protection** -- (a) Notice. Developer must provide End Users their privacy policy which identifies itself as responsible for the collection, processing, privacy, security, and integrity of all data it collects from the End User. Developer must not hold itself out as collecting any Personal Data on GitHub’s behalf. Developer’s privacy policy must provide End User’s all legally required information regarding access, collection, storage, and processing purpose of Personal Data, with whom the Personal Data is shared, and in which country or countries the Personal Data will be stored. -- (b) Purpose Limitation. - - (i) GitHub will provide Developer with Personal Data elements for the purpose of establishing and facilitating a relationship between the Developer and the End User, and permitting Developer to provide services to the End User. Developer must limit its usage of the Personal Data to that purpose, unless the End User agrees to allow different uses. - - (ii) Developer must process and communicate the Personal Data to third parties only for the limited and specific purposes of providing its services to the End User as described in its agreement with the End User, unless the End User agrees to allow different uses. -- (c) Data Quality and Proportionality. Developer must keep the Personal Data accurate and up to date. Developer must only collect Personal Data appropriate and necessary to provide the service. -- (d) Security. Developer must take all reasonable security measures appropriate to the risks, such as against accidental or unlawful destruction, or accidental loss, alteration, unauthorized disclosure or access, presented by processing the Personal Data. -- (e) Data Retention and Deletion. Upon GitHub’s reasonable request, unless prohibited by law, Developer must return or destroy all Personal Data and related data at all locations where it is stored after it is no longer needed for the limited and specified purposes for which it was collected. -- (f) Subprocessing and Onward Transfer. Developer is liable for onward transfers of Personal Data to its subprocessors. In the event that Developer must transfer the Personal Data to a third party, or Developer installs, uses, or enables third party services to process the Personal Data on Developer’s behalf, Developer must ensure that the third party will provide at least the same level of privacy protection as is required herein. +* (a) Notice. Developer must provide End Users their privacy policy which identifies itself as responsible for the collection, processing, privacy, security, and integrity of all data it collects from the End User. Developer must not hold itself out as collecting any Personal Data on GitHub’s behalf. Developer’s privacy policy must provide End User’s all legally required information regarding access, collection, storage, and processing purpose of Personal Data, with whom the Personal Data is shared, and in which country or countries the Personal Data will be stored. +* (b) Purpose Limitation. + * (i) GitHub will provide Developer with Personal Data elements for the purpose of establishing and facilitating a relationship between the Developer and the End User, and permitting Developer to provide services to the End User. Developer must limit its usage of the Personal Data to that purpose, unless the End User agrees to allow different uses. + * (ii) Developer must process and communicate the Personal Data to third parties only for the limited and specific purposes of providing its services to the End User as described in its agreement with the End User, unless the End User agrees to allow different uses. +* (c) Data Quality and Proportionality. Developer must keep the Personal Data accurate and up to date. Developer must only collect Personal Data appropriate and necessary to provide the service. +* (d) Security. Developer must take all reasonable security measures appropriate to the risks, such as against accidental or unlawful destruction, or accidental loss, alteration, unauthorized disclosure or access, presented by processing the Personal Data. +* (e) Data Retention and Deletion. Upon GitHub’s reasonable request, unless prohibited by law, Developer must return or destroy all Personal Data and related data at all locations where it is stored after it is no longer needed for the limited and specified purposes for which it was collected. +* (f) Subprocessing and Onward Transfer. Developer is liable for onward transfers of Personal Data to its subprocessors. In the event that Developer must transfer the Personal Data to a third party, or Developer installs, uses, or enables third party services to process the Personal Data on Developer’s behalf, Developer must ensure that the third party will provide at least the same level of privacy protection as is required herein. **A1-5. Use of Personal Data** -- (a) Permitted Use. Developer may process the Personal Data only for the purposes set out in Section 4(b)(i), and no other purpose. -- (b) No Use in Marketing. Developer must not use the Personal Data for the purposes of advertising any third party goods or services, and may not sell the Personal Data to any third party. -- (c) Automated Decisions. In the event that the Developer makes automated decisions affecting End User’s rights, including employment, legal, credit, or health, the Developer must provide notice to the End User. +* (a) Permitted Use. Developer may process the Personal Data only for the purposes set out in Section 4(b)(i), and no other purpose. +* (b) No Use in Marketing. Developer must not use the Personal Data for the purposes of advertising any third party goods or services, and may not sell the Personal Data to any third party. +* (c) Automated Decisions. In the event that the Developer makes automated decisions affecting End User’s rights, including employment, legal, credit, or health, the Developer must provide notice to the End User. **A1-6. Compliance** @@ -241,18 +241,18 @@ Developer will make its Privacy Statement, Privacy Policy, Privacy Notice, or an **A1-7. Termination** -- (a) Takedown. In the event that Developer is in breach of its obligations to maintain an adequate level of privacy protection, GitHub may take action in accordance with Section 4 (Takedowns) or Section 10 (Termination). -- (b) Termination. GitHub may terminate this Agreement without prejudice to any other claims at law or in equity in the event that: - - (i) the Developer notifies GitHub that it can no longer meet its privacy obligations, including loss of Developer Privacy Shield certification; - - (ii) the transfer, collection, or processing of Personal Data has been temporarily suspended for longer than one month pursuant to 7(a); - - (iii) the Developer is in substantial or persistent breach of any warranties or representations under this Data Protection Addendum; - - (iv) the Developer is no longer carrying on business, is dissolved, enters receivership, or a winding up order is made on behalf of Developer. -- (c) Notification. In the event that Developer determines that it can no longer meet its privacy obligations under this Agreement, it must notify GitHub immediately. +* (a) Takedown. In the event that Developer is in breach of its obligations to maintain an adequate level of privacy protection, GitHub may take action in accordance with Section 4 (Takedowns) or Section 10 (Termination). +* (b) Termination. GitHub may terminate this Agreement without prejudice to any other claims at law or in equity in the event that: + * (i) the Developer notifies GitHub that it can no longer meet its privacy obligations, including loss of Developer Privacy Shield certification; + * (ii) the transfer, collection, or processing of Personal Data has been temporarily suspended for longer than one month pursuant to 7(a); + * (iii) the Developer is in substantial or persistent breach of any warranties or representations under this Data Protection Addendum; + * (iv) the Developer is no longer carrying on business, is dissolved, enters receivership, or a winding up order is made on behalf of Developer. +* (c) Notification. In the event that Developer determines that it can no longer meet its privacy obligations under this Agreement, it must notify GitHub immediately. In the event that Developer was certified under Privacy Shield and allows that certification to lapse or otherwise cannot remain certified under Privacy Shield, Developer must notify GitHub immediately. -- (d) Upon Termination, Developer must: - - (i) take reasonable and appropriate steps to stop processing of Personal Data; - - (ii) within thirty days of Termination, delete any Personal Data Developer stores on GitHub’s behalf; and - - (iii) provide GitHub with reasonable assurance that Developer has stopped processing the Personal Data and deleted stored Personal Data. +* (d) Upon Termination, Developer must: + * (i) take reasonable and appropriate steps to stop processing of Personal Data; + * (ii) within thirty days of Termination, delete any Personal Data Developer stores on GitHub’s behalf; and + * (iii) provide GitHub with reasonable assurance that Developer has stopped processing the Personal Data and deleted stored Personal Data. **A1-8. Liability for Data Processing** -- Direct Liability. Developer will be liable to GitHub for actual damages caused by any breach of this Addendum subject to the terms in Section 8, Limitation on Liability. +* Direct Liability. Developer will be liable to GitHub for actual damages caused by any breach of this Addendum subject to the terms in Section 8, Limitation on Liability. diff --git a/content/site-policy/github-terms/github-sponsors-additional-terms.md b/content/site-policy/github-terms/github-sponsors-additional-terms.md index c520559dbc96..a591d6ac555e 100644 --- a/content/site-policy/github-terms/github-sponsors-additional-terms.md +++ b/content/site-policy/github-terms/github-sponsors-additional-terms.md @@ -48,19 +48,19 @@ If you are over the age of 13 but are under 18, you can give and receive Sponsor You will not under any circumstances allow payments or raise funds involving: -- Fraud, ransom, violations of intellectual property, or other illegal purposes; +* Fraud, ransom, violations of intellectual property, or other illegal purposes; -- Misrepresentation or deception related to the reasons you're raising funds or requesting sponsorship; +* Misrepresentation or deception related to the reasons you're raising funds or requesting sponsorship; -- The purchase or sale of ICOs, utility tokens, or other types of cryptocurrency; +* The purchase or sale of ICOs, utility tokens, or other types of cryptocurrency; -- The purchase or sale of securities, equity, or other types of investment offers; +* The purchase or sale of securities, equity, or other types of investment offers; -- The sale of personal information, or the processing of personal information in violation of any laws; +* The sale of personal information, or the processing of personal information in violation of any laws; -- Lotteries, raffles, gambling, pyramid schemes, self-dealing, "get rich quick schemes", deceptive marketing schemes, "donation for donation" schemes, or any attempts to game GitHub's or third parties' systems or services; and, +* Lotteries, raffles, gambling, pyramid schemes, self-dealing, "get rich quick schemes", deceptive marketing schemes, "donation for donation" schemes, or any attempts to game GitHub's or third parties' systems or services; and, -- Activities with, in, or involving countries, regions, governments, persons, or entities that are not permitted under U.S. and other economic sanctions under applicable law. +* Activities with, in, or involving countries, regions, governments, persons, or entities that are not permitted under U.S. and other economic sanctions under applicable law. ### 1.2. GitHub Sponsors Matching Fund @@ -70,25 +70,25 @@ The GitHub Sponsors Matching Fund aims to encourage the community that participa Eligibility for the GitHub Sponsors Matching Fund is evaluated on a case-by-case basis and is subject to the following limitations: -- You must have a GitHub account, be accepted into the Program as an individual, and be actively contributing to OSS. Please note, GitHub does not allow operating more than one free personal account. As such, matching is available on an individual basis and will not be approved across multiple accounts. +* You must have a GitHub account, be accepted into the Program as an individual, and be actively contributing to OSS. Please note, GitHub does not allow operating more than one free personal account. As such, matching is available on an individual basis and will not be approved across multiple accounts. -- Your use of GitHub and your Sponsored Developer Account must be, based on our determination, in our sole discretion, in accordance with the GitHub Sponsors mission to expand the opportunities to contribute to open source that upholds the [GitHub Community Guidelines](/site-policy/github-terms/github-community-guidelines). +* Your use of GitHub and your Sponsored Developer Account must be, based on our determination, in our sole discretion, in accordance with the GitHub Sponsors mission to expand the opportunities to contribute to open source that upholds the [GitHub Community Guidelines](/site-policy/github-terms/github-community-guidelines). -- You cannot receive matching for any sponsorship that originates from a user or organization account with a published GitHub Sponsors profile. +* You cannot receive matching for any sponsorship that originates from a user or organization account with a published GitHub Sponsors profile. -- GitHub reserves the right to withhold or rescind Matching Fund money and block any user from participation in the GitHub Sponsors Matching Fund for any reason, including but not limited to posting content or projects that GitHub determines are offensive or otherwise objectionable. +* GitHub reserves the right to withhold or rescind Matching Fund money and block any user from participation in the GitHub Sponsors Matching Fund for any reason, including but not limited to posting content or projects that GitHub determines are offensive or otherwise objectionable. #### 1.2.2. Matching Period. The matching period begins after GitHub accepts an individual Sponsored Developer Account into GitHub Sponsors. For each individual Sponsored Developer Account eligible for the GitHub Sponsors Matching Fund, GitHub can match community sponsorship up to $5,000 USD total during the Sponsored Developer Account's first 12 months in the Program. The matching period cannot be extended for any reason. During the matching period, GitHub will not charge any fees, so 100% of sponsorships will go to the sponsored developer. In the future, we may charge a nominal processing fee. -- If a Sponsorship or Sponsoring Subscription stops for any reason, the associated matching will stop as well. Funds that are charged back to the Sponsor before the Sponsored Developer Payment date are not eligible for matching. +* If a Sponsorship or Sponsoring Subscription stops for any reason, the associated matching will stop as well. Funds that are charged back to the Sponsor before the Sponsored Developer Payment date are not eligible for matching. -- If you leave GitHub Sponsors and rejoin later, the gap between your participation periods may count toward your matching period or your matching period may expire. +* If you leave GitHub Sponsors and rejoin later, the gap between your participation periods may count toward your matching period or your matching period may expire. -- If GitHub discovers a potential policy violation, prior to payment of any matching funds granted during the matching period, GitHub may disable payouts until an investigation has been completed, and matched funds contributed to the sponsored developer may be revoked if they are found to be in violation of this policy. +* If GitHub discovers a potential policy violation, prior to payment of any matching funds granted during the matching period, GitHub may disable payouts until an investigation has been completed, and matched funds contributed to the sponsored developer may be revoked if they are found to be in violation of this policy. -- {% data reusables.sponsors.github-contact-applicants %} +* {% data reusables.sponsors.github-contact-applicants %} ## 2. Sponsored Developer Obligations. @@ -142,13 +142,13 @@ In the event of a Sponsored Developer's breach, or suspected breach, of these Ad During the term, GitHub will remit to you all Sponsored Developer Payments received in a given month within 30 days after the close of that month, subject to the variables below. Payouts are sent through Stripe Connect, ACH transfer, or wire transfer to the bank account you provided when you applied for GitHub Sponsors. We are not responsible for delay or misapplication of any Sponsored Developer Payment because of incorrect or incomplete information supplied by you or a bank, or for failure of a bank to credit your account. -- For first payments, GitHub will remit to you all Sponsored Developer Payments 60 days after the first sponsorship is initiated, subject to the variables below. This probation period is applied to all Sponsored Developer Accounts and helps insure the integrity of the program. Payments thereafter will be remitted within 30 days of the close of that month, in accordance with this section. +* For first payments, GitHub will remit to you all Sponsored Developer Payments 60 days after the first sponsorship is initiated, subject to the variables below. This probation period is applied to all Sponsored Developer Accounts and helps insure the integrity of the program. Payments thereafter will be remitted within 30 days of the close of that month, in accordance with this section. -- If you are paid through Stripe Connect, you will receive payouts on the 22nd of the month for the balance accrued since the last payout, regardless of the amount of the balance. Payout initiation dates vary by country, and can change from month to month due to public holidays, weekends, and other factors. When the payout is a cross-border payout, a minimum payout amount may apply. For more information, see [Receiving payouts](https://stripe.com/docs/payouts#cbp-minimum-payout-amounts) in the Stripe documentation. +* If you are paid through Stripe Connect, you will receive payouts on the 22nd of the month for the balance accrued since the last payout, regardless of the amount of the balance. Payout initiation dates vary by country, and can change from month to month due to public holidays, weekends, and other factors. When the payout is a cross-border payout, a minimum payout amount may apply. For more information, see [Receiving payouts](https://stripe.com/docs/payouts#cbp-minimum-payout-amounts) in the Stripe documentation. -- If you are paid through ACH transfer or wire transfer, you will receive payouts on the third Thursday of the month. GitHub will issue a payout to you for any month that your balance reaches $100 USD. Contributions from the GitHub Sponsors Matching Fund do not count towards this threshold. If your balance is below $100 at the end of the month, the balance will accrue until the next time your balance is above the threshold at the end of the month. If you leave GitHub Sponsors, GitHub will issue a payout for your remaining balance even if the balance is below $100. +* If you are paid through ACH transfer or wire transfer, you will receive payouts on the third Thursday of the month. GitHub will issue a payout to you for any month that your balance reaches $100 USD. Contributions from the GitHub Sponsors Matching Fund do not count towards this threshold. If your balance is below $100 at the end of the month, the balance will accrue until the next time your balance is above the threshold at the end of the month. If you leave GitHub Sponsors, GitHub will issue a payout for your remaining balance even if the balance is below $100. -- After termination, we will remit to you all Sponsored Developer Payments received and unpaid within approximately 90 days after the end of the calendar month in which we recognize that these Additional Terms have been terminated. +* After termination, we will remit to you all Sponsored Developer Payments received and unpaid within approximately 90 days after the end of the calendar month in which we recognize that these Additional Terms have been terminated. ### 3.4. Payment Method. @@ -188,13 +188,13 @@ We use Stripe to make payouts to Sponsored Developer Accounts. The [Stripe Recip Sponsored Developer represents and warrants that: -- You have the authority to enter into and fully perform these Additional Terms; +* You have the authority to enter into and fully perform these Additional Terms; -- Your execution and performance of these Additional Terms will not violate any other agreement or obligation between you and any third party; +* Your execution and performance of these Additional Terms will not violate any other agreement or obligation between you and any third party; -- Sponsored Developer Content does not infringe, violate, or misappropriate any third-party right, including any copyright, trademark, patent, trade secret, moral right, privacy right, right of publicity, or any other intellectual property; +* Sponsored Developer Content does not infringe, violate, or misappropriate any third-party right, including any copyright, trademark, patent, trade secret, moral right, privacy right, right of publicity, or any other intellectual property; -- You will comply with all laws and regulations, and your Sponsored Developer Content is not illegal and does not violate any laws or regulations. +* You will comply with all laws and regulations, and your Sponsored Developer Content is not illegal and does not violate any laws or regulations. ### 4.2. Disclaimer of Warranties; Limitation of Liability; Indemnification. diff --git a/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md b/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md index 62fc23d1053d..2931d0b16c7e 100644 --- a/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md +++ b/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md @@ -21,20 +21,20 @@ When you use GitHub, you may be given access to lots of additional products and By using the Additional Products and Features, you also agree to the applicable GitHub Terms for Additional Products and Features listed below. A violation of these GitHub Terms for Additional Products and Features is a violation of the Agreement. Capitalized terms not defined here have the meaning given in the Agreement. **For Enterprise users** -- **GitHub Enterprise Cloud** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Codespaces, Dependabot Preview, GitHub Enterprise Importer, Packages, and Pages. +* **GitHub Enterprise Cloud** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Codespaces, Dependabot Preview, GitHub Enterprise Importer, Packages, and Pages. -- **GitHub Enterprise Server** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Connect, Dependabot Preview, GitHub Enterprise Importer, Packages, Pages, and SQL Server Images. +* **GitHub Enterprise Server** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Connect, Dependabot Preview, GitHub Enterprise Importer, Packages, Pages, and SQL Server Images. ## Actions GitHub Actions enables you to create custom software development lifecycle workflows directly in your GitHub repository. Actions is billed on a usage basis. The [Actions documentation](/actions) includes details, including compute and storage quantities (depending on your Account plan), and how to monitor your Actions minutes usage and set usage limits. Actions and any elements of the Actions product or service may not be used in violation of the Agreement, the [GitHub Acceptable Use Polices](/site-policy/acceptable-use-policies/github-acceptable-use-policies), or the GitHub Actions service limitations set forth in the [Actions documentation](/actions/learn-github-actions/usage-limits-billing-and-administration). Additionally, regardless of whether an Action is using self-hosted runners, Actions should not be used for: -- cryptomining; -- disrupting, gaining, or attempting to gain unauthorized access to, any service, device, data, account, or network (other than those authorized by the [GitHub Bug Bounty program](https://bounty.github.com)); -- the provision of a stand-alone or integrated application or service offering the Actions product or service, or any elements of the Actions product or service, for commercial purposes; -- any activity that places a burden on our servers, where that burden is disproportionate to the benefits provided to users (for example, don't use Actions as a content delivery network or as part of a serverless application, but a low benefit Action could be ok if it’s also low burden); or -- if using GitHub-hosted runners, any other activity unrelated to the production, testing, deployment, or publication of the software project associated with the repository where GitHub Actions are used. +* cryptomining; +* disrupting, gaining, or attempting to gain unauthorized access to, any service, device, data, account, or network (other than those authorized by the [GitHub Bug Bounty program](https://bounty.github.com)); +* the provision of a stand-alone or integrated application or service offering the Actions product or service, or any elements of the Actions product or service, for commercial purposes; +* any activity that places a burden on our servers, where that burden is disproportionate to the benefits provided to users (for example, don't use Actions as a content delivery network or as part of a serverless application, but a low benefit Action could be ok if it’s also low burden); or +* if using GitHub-hosted runners, any other activity unrelated to the production, testing, deployment, or publication of the software project associated with the repository where GitHub Actions are used. In order to prevent violations of these limitations and abuse of GitHub Actions, GitHub may monitor your use of GitHub Actions. Misuse of GitHub Actions may result in termination of jobs, restrictions in your ability to use GitHub Actions, disabling of repositories created to run Actions in a way that violates these Terms, or in some cases, suspension or termination of your GitHub account. @@ -79,11 +79,11 @@ The GitHub Advisory Database is licensed under the [Creative Commons Attribution _Note: The github.dev service, available by pressing . on a repo or navigating directly to github.dev, is governed by GitHub's Beta Terms of service._ GitHub Codespaces enables you to develop code directly from your browser using the code within your GitHub repository. Codespaces and any elements of the Codespaces service may not be used in violation of the Agreement or the Acceptable Use Policies. Additionally, Codespaces should not be used for: -- cryptomining; -- using our servers to disrupt, or to gain or to attempt to gain unauthorized access to any service, device, data, account or network (other than those authorized by the GitHub Bug Bounty program); -- the provision of a stand-alone or integrated application or service offering Codespaces or any elements of Codespaces for commercial purposes; -- any activity that places a burden on our servers, where that burden is disproportionate to the benefits provided to users (for example, don't use Codespaces as a content delivery network, as part of a serverless application, or to host any kind of production-facing application); or -- any other activity unrelated to the development or testing of the software project associated with the repository where GitHub Codespaces is initiated. +* cryptomining; +* using our servers to disrupt, or to gain or to attempt to gain unauthorized access to any service, device, data, account or network (other than those authorized by the GitHub Bug Bounty program); +* the provision of a stand-alone or integrated application or service offering Codespaces or any elements of Codespaces for commercial purposes; +* any activity that places a burden on our servers, where that burden is disproportionate to the benefits provided to users (for example, don't use Codespaces as a content delivery network, as part of a serverless application, or to host any kind of production-facing application); or +* any other activity unrelated to the development or testing of the software project associated with the repository where GitHub Codespaces is initiated. In order to prevent violations of these limitations and abuse of GitHub Codespaces, GitHub may monitor your use of GitHub Codespaces. Misuse of GitHub Codespaces may result in termination of your access to Codespaces, restrictions in your ability to use GitHub Codespaces, or the disabling of repositories created to run Codespaces in a way that violates these Terms. diff --git a/content/site-policy/github-terms/github-terms-of-service.md b/content/site-policy/github-terms/github-terms-of-service.md index abaae533b099..9d9572cc4a98 100644 --- a/content/site-policy/github-terms/github-terms-of-service.md +++ b/content/site-policy/github-terms/github-terms-of-service.md @@ -63,9 +63,9 @@ Effective date: November 16, 2020 ### 1. Account Controls -- Users. Subject to these Terms, you retain ultimate administrative control over your Personal Account and the Content within it. +* Users. Subject to these Terms, you retain ultimate administrative control over your Personal Account and the Content within it. -- Organizations. The "owner" of an Organization that was created under these Terms has ultimate administrative control over that Organization and the Content within it. Within the Service, an owner can manage User access to the Organization’s data and projects. An Organization may have multiple owners, but there must be at least one Personal Account designated as an owner of an Organization. If you are the owner of an Organization under these Terms, we consider you responsible for the actions that are performed on or through that Organization. +* Organizations. The "owner" of an Organization that was created under these Terms has ultimate administrative control over that Organization and the Content within it. Within the Service, an owner can manage User access to the Organization’s data and projects. An Organization may have multiple owners, but there must be at least one Personal Account designated as an owner of an Organization. If you are the owner of an Organization under these Terms, we consider you responsible for the actions that are performed on or through that Organization. ### 2. Required Information @@ -74,19 +74,19 @@ You must provide a valid email address in order to complete the signup process. ### 3. Account Requirements We have a few simple rules for Personal Accounts on GitHub's Service. -- You must be a human to create an Account. Accounts registered by "bots" or other automated methods are not permitted. We do permit machine accounts: -- A machine account is an Account set up by an individual human who accepts the Terms on behalf of the Account, provides a valid email address, and is responsible for its actions. A machine account is used exclusively for performing automated tasks. Multiple users may direct the actions of a machine account, but the owner of the Account is ultimately responsible for the machine's actions. You may maintain no more than one free machine account in addition to your free Personal Account. -- One person or legal entity may maintain no more than one free Account (if you choose to control a machine account as well, that's fine, but it can only be used for running a machine). -- You must be age 13 or older. While we are thrilled to see brilliant young coders get excited by learning to program, we must comply with United States law. GitHub does not target our Service to children under 13, and we do not permit any Users under 13 on our Service. If we learn of any User under the age of 13, we will [terminate that User’s Account immediately](#l-cancellation-and-termination). If you are a resident of a country outside the United States, your country’s minimum age may be older; in such a case, you are responsible for complying with your country’s laws. -- Your login may only be used by one person — i.e., a single login may not be shared by multiple people. A paid Organization may only provide access to as many Personal Accounts as your subscription allows. -- You may not use GitHub in violation of export control or sanctions laws of the United States or any other applicable jurisdiction. You may not use GitHub if you are or are working on behalf of a [Specially Designated National (SDN)](https://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx) or a person subject to similar blocking or denied party prohibitions administered by a U.S. government agency. GitHub may allow persons in certain sanctioned countries or territories to access certain GitHub services pursuant to U.S. government authorizations. For more information, please see our [Export Controls policy](/site-policy/other-site-policies/github-and-trade-controls). +* You must be a human to create an Account. Accounts registered by "bots" or other automated methods are not permitted. We do permit machine accounts: +* A machine account is an Account set up by an individual human who accepts the Terms on behalf of the Account, provides a valid email address, and is responsible for its actions. A machine account is used exclusively for performing automated tasks. Multiple users may direct the actions of a machine account, but the owner of the Account is ultimately responsible for the machine's actions. You may maintain no more than one free machine account in addition to your free Personal Account. +* One person or legal entity may maintain no more than one free Account (if you choose to control a machine account as well, that's fine, but it can only be used for running a machine). +* You must be age 13 or older. While we are thrilled to see brilliant young coders get excited by learning to program, we must comply with United States law. GitHub does not target our Service to children under 13, and we do not permit any Users under 13 on our Service. If we learn of any User under the age of 13, we will [terminate that User’s Account immediately](#l-cancellation-and-termination). If you are a resident of a country outside the United States, your country’s minimum age may be older; in such a case, you are responsible for complying with your country’s laws. +* Your login may only be used by one person — i.e., a single login may not be shared by multiple people. A paid Organization may only provide access to as many Personal Accounts as your subscription allows. +* You may not use GitHub in violation of export control or sanctions laws of the United States or any other applicable jurisdiction. You may not use GitHub if you are or are working on behalf of a [Specially Designated National (SDN)](https://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx) or a person subject to similar blocking or denied party prohibitions administered by a U.S. government agency. GitHub may allow persons in certain sanctioned countries or territories to access certain GitHub services pursuant to U.S. government authorizations. For more information, please see our [Export Controls policy](/site-policy/other-site-policies/github-and-trade-controls). ### 4. Account Security You are responsible for keeping your Account secure while you use our Service. We offer tools such as two-factor authentication to help you maintain your Account's security, but the content of your Account and its security are up to you. -- You are responsible for all content posted and activity that occurs under your Account (even when content is posted by others who have Accounts under your Account). -- You are responsible for maintaining the security of your Account and password. GitHub cannot and will not be liable for any loss or damage from your failure to comply with this security obligation. -- You will promptly notify GitHub by contacting us through the [GitHub Support portal](https://support.github.com/) if you become aware of any unauthorized use of, or access to, our Service through your Account, including any unauthorized use of your password or Account. +* You are responsible for all content posted and activity that occurs under your Account (even when content is posted by others who have Accounts under your Account). +* You are responsible for maintaining the security of your Account and password. GitHub cannot and will not be liable for any loss or damage from your failure to comply with this security obligation. +* You will promptly notify GitHub by contacting us through the [GitHub Support portal](https://support.github.com/) if you become aware of any unauthorized use of, or access to, our Service through your Account, including any unauthorized use of your password or Account. ### 5. Additional Terms @@ -163,7 +163,7 @@ GitHub considers the contents of private repositories to be confidential to you. GitHub personnel may only access the content of your private repositories in the situations described in our [Privacy Statement](/site-policy/privacy-policies/github-privacy-statement#repository-contents). You may choose to enable additional access to your private repositories. For example: -- You may enable various GitHub services or features that require additional rights to Your Content in private repositories. These rights may vary depending on the service or feature, but GitHub will continue to treat your private repository Content as confidential. If those services or features require rights in addition to those we need to provide the GitHub Service, we will provide an explanation of those rights. +* You may enable various GitHub services or features that require additional rights to Your Content in private repositories. These rights may vary depending on the service or feature, but GitHub will continue to treat your private repository Content as confidential. If those services or features require rights in addition to those we need to provide the GitHub Service, we will provide an explanation of those rights. Additionally, we may be [compelled by law](/site-policy/privacy-policies/github-privacy-statement#for-legal-disclosure) to disclose the contents of your private repositories. @@ -241,10 +241,10 @@ Our pricing and payment terms are available at [github.com/pricing](https://gith ### 2. Upgrades, Downgrades, and Changes -- We will immediately bill you when you upgrade from the free plan to any paying plan. -- If you change from a monthly billing plan to a yearly billing plan, GitHub will bill you for a full year at the next monthly billing date. -- If you upgrade to a higher level of service, we will bill you for the upgraded plan immediately. -- You may change your level of service at any time by [choosing a plan option](https://github.com/pricing) or going into your [Billing settings](https://github.com/settings/billing). If you choose to downgrade your Account, you may lose access to Content, features, or capacity of your Account. Please see our section on [Cancellation](#l-cancellation-and-termination) for information on getting a copy of that Content. +* We will immediately bill you when you upgrade from the free plan to any paying plan. +* If you change from a monthly billing plan to a yearly billing plan, GitHub will bill you for a full year at the next monthly billing date. +* If you upgrade to a higher level of service, we will bill you for the upgraded plan immediately. +* You may change your level of service at any time by [choosing a plan option](https://github.com/pricing) or going into your [Billing settings](https://github.com/settings/billing). If you choose to downgrade your Account, you may lose access to Content, features, or capacity of your Account. Please see our section on [Cancellation](#l-cancellation-and-termination) for information on getting a copy of that Content. ### 3. Billing Schedule; No Refunds @@ -316,14 +316,14 @@ GitHub does not warrant that the Service will meet your requirements; that the S You understand and agree that we will not be liable to you or any third party for any loss of profits, use, goodwill, or data, or for any incidental, indirect, special, consequential or exemplary damages, however arising, that result from -- the use, disclosure, or display of your User-Generated Content; -- your use or inability to use the Service; -- any modification, price change, suspension or discontinuance of the Service; -- the Service generally or the software or systems that make the Service available; -- unauthorized access to or alterations of your transmissions or data; -- statements or conduct of any third party on the Service; -- any other user interactions that you input or receive through your use of the Service; or -- any other matter relating to the Service. +* the use, disclosure, or display of your User-Generated Content; +* your use or inability to use the Service; +* any modification, price change, suspension or discontinuance of the Service; +* the Service generally or the software or systems that make the Service available; +* unauthorized access to or alterations of your transmissions or data; +* statements or conduct of any third party on the Service; +* any other user interactions that you input or receive through your use of the Service; or +* any other matter relating to the Service. Our liability is limited whether or not we have been informed of the possibility of such damages, and even if a remedy set forth in this Agreement is found to have failed of its essential purpose. We will have no liability for any failure or delay due to matters beyond our reasonable control. diff --git a/content/site-policy/other-site-policies/github-deceased-user-policy.md b/content/site-policy/other-site-policies/github-deceased-user-policy.md index bb838681819d..1df37a4c3a80 100644 --- a/content/site-policy/other-site-policies/github-deceased-user-policy.md +++ b/content/site-policy/other-site-policies/github-deceased-user-policy.md @@ -14,13 +14,13 @@ In the event that a GitHub user passes away, we can work with an authorized indi If you are next of kin, a [pre-designated successor](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories), or other authorized individual (which could include a collaborator or business partner) of a deceased user and would like to make a request regarding their account, you can reach out to us through the [GitHub Support portal](https://support.github.com/). In the portal, click **Contact us**, and provide the following information in your message: -- Name -- Contact Information -- Name of the deceased account holder -- GitHub username of the deceased account holder -- Your relationship to the deceased account holder (please include whether you have been designated as the account successor on GitHub.com) -- If designated as account successor, the username of your GitHub account -- What action you are seeking (e.g. transfer public repositories, cancel billing on account) +* Name +* Contact Information +* Name of the deceased account holder +* GitHub username of the deceased account holder +* Your relationship to the deceased account holder (please include whether you have been designated as the account successor on GitHub.com) +* If designated as account successor, the username of your GitHub account +* What action you are seeking (e.g. transfer public repositories, cancel billing on account) Once we have received your request, we may follow up with a request for additional information, such as a copy of your photo identification, copy of the death certificate, and documentation confirming you are authorized to act in relation to the deceased user’s account, to verify that we are properly authorized to process your request. diff --git a/content/site-policy/other-site-policies/github-government-takedown-policy.md b/content/site-policy/other-site-policies/github-government-takedown-policy.md index f9c1bcaf3996..27883b7b53e7 100644 --- a/content/site-policy/other-site-policies/github-government-takedown-policy.md +++ b/content/site-policy/other-site-policies/github-government-takedown-policy.md @@ -17,17 +17,17 @@ From time to time, GitHub receives requests from governments to remove content t ## What is a complete government takedown request? To count as a complete request, a request or notice must -- come from a relevant, official government agency -- identify illegal content -- specify the source of illegality in that jurisdiction (law or court order). +* come from a relevant, official government agency +* identify illegal content +* specify the source of illegality in that jurisdiction (law or court order). ## What happens when we receive a complete takedown request from a government? When we receive a notice from a relevant, official government agency that identifies illegal content and specifies the source of the illegality, we -- notify the affected users of the specific content that allegedly violates the law, and that this is a legal takedown request -- allow the affected users to appeal the decision as part of that notification -- limit the geographic scope of the takedown when possible and include that as part of the notification -- post the official request that led to the takedown in our public [gov-takedowns repository](https://github.com/github/gov-takedowns). +* notify the affected users of the specific content that allegedly violates the law, and that this is a legal takedown request +* allow the affected users to appeal the decision as part of that notification +* limit the geographic scope of the takedown when possible and include that as part of the notification +* post the official request that led to the takedown in our public [gov-takedowns repository](https://github.com/github/gov-takedowns). ## Why do we publicly post takedown notices? diff --git a/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md b/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md index 30ae60ed8dcc..c2488ea5886c 100644 --- a/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md +++ b/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md @@ -19,9 +19,9 @@ Either way, you're on the right page. In these guidelines, we provide a little background about what GitHub is, the types of data we have, and the conditions under which we will disclose private user information. Before we get into the details, however, here are a few important details you may want to know: -- We will [**notify affected users**](#we-will-notify-any-affected-account-owners) about any requests for their account information, unless prohibited from doing so by law or court order. -- We will not disclose **location-tracking data**, such as IP address logs, without a [valid court order or search warrant](#with-a-court-order-or-a-search-warrant). -- We will not disclose any **private user content**, including the contents of private repositories, without a valid [search warrant](#only-with-a-search-warrant). +* We will [**notify affected users**](#we-will-notify-any-affected-account-owners) about any requests for their account information, unless prohibited from doing so by law or court order. +* We will not disclose **location-tracking data**, such as IP address logs, without a [valid court order or search warrant](#with-a-court-order-or-a-search-warrant). +* We will not disclose any **private user content**, including the contents of private repositories, without a valid [search warrant](#only-with-a-search-warrant). ## About these guidelines @@ -43,29 +43,29 @@ Before asking us to disclose data, it may be useful to understand how our system GitHub hosts millions of data repositories using the [Git version control system](https://git-scm.com/video/what-is-version-control). Repositories on GitHub—which may be public or private—are most commonly used for software development projects, but are also often used to work on content of all kinds. -- [**Users**](/get-started/learning-about-github/github-glossary#user) — +* [**Users**](/get-started/learning-about-github/github-glossary#user) — Users are represented in our system as personal GitHub accounts. Each user has a personal profile, and can own multiple repositories. Users can create or be invited to join organizations or to collaborate on another user's repository. -- [**Collaborators**](/get-started/learning-about-github/github-glossary#collaborator) — +* [**Collaborators**](/get-started/learning-about-github/github-glossary#collaborator) — A collaborator is a user with read and write access to a repository who has been invited to contribute by the repository owner. -- [**Organizations**](/get-started/learning-about-github/github-glossary#organization) — +* [**Organizations**](/get-started/learning-about-github/github-glossary#organization) — Organizations are a group of two or more users that typically mirror real-world organizations, such as businesses or projects. They are administered by users and can contain both repositories and teams of users. -- [**Repositories**](/get-started/learning-about-github/github-glossary#repository) — +* [**Repositories**](/get-started/learning-about-github/github-glossary#repository) — A repository is one of the most basic GitHub elements. They may be easiest to imagine as a project's folder. A repository contains all of the project files (including documentation), and stores each file's revision history. Repositories can have multiple collaborators and, at its administrators' discretion, may be publicly viewable or not. -- [**Pages**](/pages/getting-started-with-github-pages/about-github-pages) — +* [**Pages**](/pages/getting-started-with-github-pages/about-github-pages) — GitHub Pages are public webpages freely hosted by GitHub that users can easily publish through code stored in their repositories. If a user or organization has a GitHub Page, it can usually be found at a URL such as `https://username.github.io` or they may have the webpage mapped to their own custom domain name. -- [**Gists**](/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists) — +* [**Gists**](/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists) — Gists are snippets of source code or other text that users can use to store ideas or share with friends. Like regular GitHub repositories, Gists are created with Git, so they are automatically versioned, forkable and downloadable. Gists can either be public or secret (accessible only through a known URL). Public Gists cannot be converted into secret Gists. @@ -74,75 +74,75 @@ Gists can either be public or secret (accessible only through a known URL). Publ Here is a non-exhaustive list of the kinds of data we maintain about users and projects on GitHub. -- +* **Public account data** — There is a variety of information publicly available on GitHub about users and their repositories. User profiles can be found at a URL such as `https://github.com/username`. User profiles display information about when the user created their account as well their public activity on GitHub.com and social interactions. Public user profiles can also include additional information that a user may have chosen to share publicly. All user public profiles display: - - Username - - The repositories that the user has starred - - The other GitHub users the user follows - - The users that follow them + * Username + * The repositories that the user has starred + * The other GitHub users the user follows + * The users that follow them Optionally, a user may also choose to share the following information publicly: - - Their real name - - An avatar - - An affiliated company - - Their location - - A public email address - - Their personal web page - - Organizations to which the user is a member (_depending on either the organizations' or the users' preferences_) - -- + * Their real name + * An avatar + * An affiliated company + * Their location + * A public email address + * Their personal web page + * Organizations to which the user is a member (_depending on either the organizations' or the users' preferences_) + +* **Private account data** — GitHub also collects and maintains certain private information about users as outlined in our [Privacy Policy](/site-policy/privacy-policies/github-privacy-statement). This may include: - - Private email addresses - - Payment details - - Security access logs - - Data about interactions with private repositories + * Private email addresses + * Payment details + * Security access logs + * Data about interactions with private repositories To get a sense of the type of private account information that GitHub collects, you can visit your {% data reusables.user-settings.personal_dashboard %} and browse through the sections in the left-hand menubar. -- +* **Organization account data** — Information about organizations, their administrative users and repositories is publicly available on GitHub. Organization profiles can be found at a URL such as `https://github.com/organization`. Public organization profiles can also include additional information that the owners have chosen to share publicly. All organization public profiles display: - - The organization name - - The repositories that the owners have starred - - All GitHub users that are owners of the organization + * The organization name + * The repositories that the owners have starred + * All GitHub users that are owners of the organization Optionally, administrative users may also choose to share the following information publicly: - - An avatar - - An affiliated company - - Their location - - Direct Members and Teams - - Collaborators + * An avatar + * An affiliated company + * Their location + * Direct Members and Teams + * Collaborators -- +* **Public repository data** — GitHub is home to millions of public, open-source software projects. You can browse almost any public repository (for example, the [GitHub Docs](https://github.com/github/docs)) to get a sense for the information that GitHub collects and maintains about repositories. This can include: - - The code itself - - Previous versions of the code - - Stable release versions of the project - - Information about collaborators, contributors and repository members - - Logs of Git operations such as commits, branching, pushing, pulling, forking and cloning - - Conversations related to Git operations such as comments on pull requests or commits - - Project documentation such as Issues and Wiki pages - - Statistics and graphs showing contributions to the project and the network of contributors + * The code itself + * Previous versions of the code + * Stable release versions of the project + * Information about collaborators, contributors and repository members + * Logs of Git operations such as commits, branching, pushing, pulling, forking and cloning + * Conversations related to Git operations such as comments on pull requests or commits + * Project documentation such as Issues and Wiki pages + * Statistics and graphs showing contributions to the project and the network of contributors -- +* **Private repository data** — GitHub collects and maintains the same type of data for private repositories that can be seen for public repositories, except only specifically invited users may access private repository data. -- +* **Other data** — Additionally, GitHub collects analytics data such as page visits and information occasionally volunteered by our users (such as communications with our support team, survey information and/or site registrations). @@ -157,48 +157,48 @@ GitHub reserves the right to object to any requests for non-public information. Where GitHub agrees to produce non-public information in response to a lawful request, we will conduct a reasonable search for the requested information. Here are the kinds of information we will agree to produce, depending on the kind of legal process we are served with: -- +* **With user consent** — GitHub will provide private account information, if requested, directly to the user (or an owner, in the case of an organization account), or to a designated third party with the user's written consent once GitHub is satisfied that the user has verified his or her identity. -- +* **With a subpoena** — If served with a valid subpoena, civil investigative demand, or similar legal process issued in connection with an official criminal or civil investigation, we can provide certain non-public account information, which may include: - - Name(s) associated with the account - - Email address(es) associated with the account - - Billing information - - Registration date and termination date - - IP address, date, and time at the time of account registration - - IP address(es) used to access the account at a specified time or event relevant to the investigation + * Name(s) associated with the account + * Email address(es) associated with the account + * Billing information + * Registration date and termination date + * IP address, date, and time at the time of account registration + * IP address(es) used to access the account at a specified time or event relevant to the investigation In the case of organization accounts, we can provide the name(s) and email address(es) of the account owner(s) as well as the date and IP address at the time of creation of the organization account. We will not produce information about other members or contributors, if any, to the organization account or any additional information regarding the identified account owner(s) without a follow-up request for those specific users. Please note that the information available will vary from case to case. Some of the information is optional for users to provide. In other cases, we may not have collected or retained the information. -- +* **With a court order _or_ a search warrant** — We will not disclose account access logs unless compelled to do so by either (i) a court order issued under 18 U.S.C. Section 2703(d), upon a showing of specific and articulable facts showing that there are reasonable grounds to believe that the information sought is relevant and material to an ongoing criminal investigation; or (ii) a search warrant issued under the procedures described in the Federal Rules of Criminal Procedure or equivalent state warrant procedures, upon a showing of probable cause. In addition to the non-public account information listed above, we can provide account access logs in response to a court order or search warrant, which may include: - - Any logs which would reveal a user's movements over a period of time - - Account or private repository settings (for example, which users have certain permissions, etc.) - - User- or IP-specific analytic data such as browsing history - - Security access logs other than account creation or for a specific time and date + * Any logs which would reveal a user's movements over a period of time + * Account or private repository settings (for example, which users have certain permissions, etc.) + * User- or IP-specific analytic data such as browsing history + * Security access logs other than account creation or for a specific time and date -- +* **Only with a search warrant** — We will not disclose the private contents of any account unless compelled to do so under a search warrant issued under the procedures described in the Federal Rules of Criminal Procedure or equivalent state warrant procedures upon a showing of probable cause. In addition to the non-public account information and account access logs mentioned above, we will also provide private account contents in response to a search warrant, which may include: - - Contents of secret Gists - - Source code or other content in private repositories - - Contribution and collaboration records for private repositories - - Communications or documentation (such as Issues or Wikis) in private repositories - - Any security keys used for authentication or encryption + * Contents of secret Gists + * Source code or other content in private repositories + * Contribution and collaboration records for private repositories + * Communications or documentation (such as Issues or Wikis) in private repositories + * Any security keys used for authentication or encryption -- +* **Under exigent circumstances** — If we receive a request for information under certain exigent circumstances (where we believe the disclosure is necessary to prevent an emergency involving danger of death or serious physical injury to a person), we may disclose limited information that we determine necessary to enable law enforcement to address the emergency. For any information beyond that, we would require a subpoena, search warrant, or court order, as described above. For example, we will not disclose contents of private repositories without a search warrant. Before disclosing information, we confirm that the request came from a law enforcement agency, an authority sent an official notice summarizing the emergency, and how the information requested will assist in addressing the emergency. @@ -208,10 +208,10 @@ Under state and federal law, GitHub can seek reimbursement for costs associated While we do not charge in emergency situations or in other exigent circumstances, we seek reimbursement for all other legal requests in accordance with the following schedule, unless otherwise required by law: -- Initial search of up to 25 identifiers: Free -- Production of subscriber information/data for up to 5 accounts: Free -- Production of subscriber information/data for more than 5 accounts: $20 per account -- Secondary searches: $10 per search +* Initial search of up to 25 identifiers: Free +* Production of subscriber information/data for up to 5 accounts: Free +* Production of subscriber information/data for more than 5 accounts: $20 per account +* Secondary searches: $10 per search ## Data preservation @@ -232,12 +232,12 @@ Courtesy copies may be emailed to legal-support@github.com Please make your requests as specific and narrow as possible, including the following information: -- Full information about authority issuing the request for information -- The name and badge/ID of the responsible agent -- An official email address and contact phone number -- The user, organization, repository name(s) of interest -- The URLs of any pages, gists or files of interest -- The description of the types of records you need +* Full information about authority issuing the request for information +* The name and badge/ID of the responsible agent +* An official email address and contact phone number +* The user, organization, repository name(s) of interest +* The URLs of any pages, gists or files of interest +* The description of the types of records you need Please allow at least two weeks for us to be able to look into your request. diff --git a/content/site-policy/privacy-policies/github-candidate-privacy-policy.md b/content/site-policy/privacy-policies/github-candidate-privacy-policy.md index 0f1f15a446a8..bf041f5687f3 100644 --- a/content/site-policy/privacy-policies/github-candidate-privacy-policy.md +++ b/content/site-policy/privacy-policies/github-candidate-privacy-policy.md @@ -38,15 +38,15 @@ The Candidate Personal Information we collect, use, and maintain (or “process ## How do we use the Candidate Personal Information we collect? We use the Candidate Personal Information for the following purposes: - - To assess your skills, qualifications and interests for employment opportunities with GitHub; - - To verify the information provided by you or others, including checking your references; - - To communicate with you about your application and the recruitment process, including informing you of other potential employment opportunities at GitHub; - - If you were referred, to inform the referrer of the status of your application; - - If you are offered a position, to prepare your offer letter and conduct a background check (to the extent permitted by applicable law); - - If you are offered a position and where requested by you, to assist you with obtaining an immigration visa or work permit; - - To comply with local laws, regulations, legal processes or enforceable government requests; and - - To prepare and submit reports as required under local laws and regulations; - - To manage and improve our application and recruitment process (such as making the application process more efficient and improving our diversity practices). + * To assess your skills, qualifications and interests for employment opportunities with GitHub; + * To verify the information provided by you or others, including checking your references; + * To communicate with you about your application and the recruitment process, including informing you of other potential employment opportunities at GitHub; + * If you were referred, to inform the referrer of the status of your application; + * If you are offered a position, to prepare your offer letter and conduct a background check (to the extent permitted by applicable law); + * If you are offered a position and where requested by you, to assist you with obtaining an immigration visa or work permit; + * To comply with local laws, regulations, legal processes or enforceable government requests; and + * To prepare and submit reports as required under local laws and regulations; + * To manage and improve our application and recruitment process (such as making the application process more efficient and improving our diversity practices). ## How do we share your Candidate Personal Information? diff --git a/content/site-policy/privacy-policies/github-general-privacy-statement.md b/content/site-policy/privacy-policies/github-general-privacy-statement.md index f2015216f553..bfe74c149db5 100644 --- a/content/site-policy/privacy-policies/github-general-privacy-statement.md +++ b/content/site-policy/privacy-policies/github-general-privacy-statement.md @@ -28,8 +28,8 @@ Welcome to the GitHub Privacy Statement. This is where we describe how we handle When a school or employer supplies your GitHub account, they assume the role of Data Controller for most Personal Data used in our Services. This enables them to: -- Manage and administer your GitHub account, including adjusting privacy settings. -- Access and utilize your Personal Data, which includes details on how you use the Services, as well as your content and files. +* Manage and administer your GitHub account, including adjusting privacy settings. +* Access and utilize your Personal Data, which includes details on how you use the Services, as well as your content and files. Should you access a GitHub Service through an account provided by an organization, such as your employer or school, the organization becomes the Data Controller, and this Privacy Statement's direct applicability to you changes. Even so, GitHub remains dedicated to preserving your privacy rights. In such circumstances, GitHub functions as a Data Processor, adhering to the Data Controller's instructions regarding your Personal Data's processing. A Data Protection Agreement governs the relationship between GitHub and the Data Controller. For further details regarding their privacy practices, please refer to the privacy statement of the organization providing your account. @@ -45,47 +45,47 @@ Personal Data is collected from you directly, automatically from your device, an ### From You -- Account Data: We collect certain information when you open an account such as your GitHub handle, name, email address, password, payment information and transaction information. -- User Content and Files: When you use our Services, we collect Personal Data included as part of the information you provide such as code, inputs, text, documents, images, or feedback. -- Demographic information: In some cases, you provide us with ethnicity, gender, or similar demographic details. -- Feedback Data: This consists of information you submit through surveys, reviews, or interactive features. -- Payment Information: For paid subscriptions, we collect details like name, billing address, and payment specifics. -- Profile Information: We collect information to create a user profile, which may include a photo, additional email addresses, job title, or biography. -- Sales and Marketing Data: This includes information provided for promotional communications, such as name, email address, and company name. -- Support Data: When you seek customer support, we collect details like code, text, or multimedia files. +* Account Data: We collect certain information when you open an account such as your GitHub handle, name, email address, password, payment information and transaction information. +* User Content and Files: When you use our Services, we collect Personal Data included as part of the information you provide such as code, inputs, text, documents, images, or feedback. +* Demographic information: In some cases, you provide us with ethnicity, gender, or similar demographic details. +* Feedback Data: This consists of information you submit through surveys, reviews, or interactive features. +* Payment Information: For paid subscriptions, we collect details like name, billing address, and payment specifics. +* Profile Information: We collect information to create a user profile, which may include a photo, additional email addresses, job title, or biography. +* Sales and Marketing Data: This includes information provided for promotional communications, such as name, email address, and company name. +* Support Data: When you seek customer support, we collect details like code, text, or multimedia files. ### Automatically -- Buttons, Tools, and Content from Other Companies: Our Services may contain links or buttons that lead to third-party services like Twitter or LinkedIn. Use of these features may result in data collection. Engaging with these buttons, tools, or content may automatically send certain browser information to these companies. Please review the privacy statements of these companies for more information. -- Essential Cookies and Similar Tracking Technologies: We use cookies and similar technologies to provide essential functionality like storing settings and recognizing you while using our Services. -- Non-essential Cookies: Depending on your jurisdiction, we may use online analytics products that use cookies to help us analyze how de-identified users use our Services and to enhance your experience when you use the Services. We may also employ third-party Cookies to gather data for interest-based advertising. In some jurisdictions, we only use non-essential cookies after obtaining your consent. See [this](#what-are-your-cookie-choices-and-controls) section for more details and control options. -- Email Marketing Interactions: Our emails may have web beacons that offer information on your device type, email client, email reception, opens, and link clicks. -- Geolocation Information: Depending on the Service's functionality, we collect regional geolocation data -- Service Usage Information: We collect data about your interactions with the Services, such as IP address, device information, session details, date and time of requests, device type and ID, operating system and application version, information related to your contributions to repositories, and performance of specific features or Services. -- Website Usage Data: We automatically log data about your Website interactions, including the referring site, date and time of visit, pages viewed, and links clicked. +* Buttons, Tools, and Content from Other Companies: Our Services may contain links or buttons that lead to third-party services like Twitter or LinkedIn. Use of these features may result in data collection. Engaging with these buttons, tools, or content may automatically send certain browser information to these companies. Please review the privacy statements of these companies for more information. +* Essential Cookies and Similar Tracking Technologies: We use cookies and similar technologies to provide essential functionality like storing settings and recognizing you while using our Services. +* Non-essential Cookies: Depending on your jurisdiction, we may use online analytics products that use cookies to help us analyze how de-identified users use our Services and to enhance your experience when you use the Services. We may also employ third-party Cookies to gather data for interest-based advertising. In some jurisdictions, we only use non-essential cookies after obtaining your consent. See [this](#what-are-your-cookie-choices-and-controls) section for more details and control options. +* Email Marketing Interactions: Our emails may have web beacons that offer information on your device type, email client, email reception, opens, and link clicks. +* Geolocation Information: Depending on the Service's functionality, we collect regional geolocation data +* Service Usage Information: We collect data about your interactions with the Services, such as IP address, device information, session details, date and time of requests, device type and ID, operating system and application version, information related to your contributions to repositories, and performance of specific features or Services. +* Website Usage Data: We automatically log data about your Website interactions, including the referring site, date and time of visit, pages viewed, and links clicked. ### From Third Parties -- Information from Other Users of the Services: Other users may share information about you when they submit issues and comments. We may also receive information about you if you are identified as a representative or administrator on your company's account. -- Publicly Available Sources: We may acquire information about you from publicly available sources like public GitHub repositories. -- Services you linked to your GitHub account: When you or your administrator integrate third-party apps or services with our Services, we receive information based on your settings with those services. This can include details like your name and email from services like Google for authentication. The information we receive depends on the third-party's settings and privacy policies. Always review these to understand what data is shared with our Services. -- Vendors, Partners, and Affiliates: We may receive information about you from third parties, like vendors, resellers, partners, or affiliates for the purposes outlined in this statement. +* Information from Other Users of the Services: Other users may share information about you when they submit issues and comments. We may also receive information about you if you are identified as a representative or administrator on your company's account. +* Publicly Available Sources: We may acquire information about you from publicly available sources like public GitHub repositories. +* Services you linked to your GitHub account: When you or your administrator integrate third-party apps or services with our Services, we receive information based on your settings with those services. This can include details like your name and email from services like Google for authentication. The information we receive depends on the third-party's settings and privacy policies. Always review these to understand what data is shared with our Services. +* Vendors, Partners, and Affiliates: We may receive information about you from third parties, like vendors, resellers, partners, or affiliates for the purposes outlined in this statement. ## Processing Purposes: How We Use Your Personal Data The Personal Data we process depends on your interaction and access methods with our Services, including the interfaces (web, desktop, mobile apps), features used (pull requests, Codespaces, GitHub Copilot), and your preferred access tools (like your IDE). This section details all the potential ways GitHub may process your Personal Data: -- Business Operations: We use Personal Data for activities like billing, accounting, and compensation. This includes creating aggregated statistical data for internal reporting, financial reporting, revenue planning, capacity planning, and forecast modeling (including product strategy). -- Communication: We use Personal Data to inform you about new Services, features, offers, promotions, and other pertinent information. This also includes sending confirmations, invoices, technical notices, updates, security alerts, and administrative messages. -- Inference: We generate new information from other data we collect to derive likely preferences or other characteristics. For instance, we infer your general geographic location based on your IP address. -- Personalization: We use Personal Data to customize the Service to your preferences, to evaluate the effectiveness of enterprise business ads and promotional communications, and to ensure a seamless and consistent user experience. -- Safety and Security: To promote safety, integrity, and security across our Services, we process Personal Data, using both automated and, at times, manual techniques for abuse detection, prevention, and violations of terms of service. -- Service Provision: We use Personal Data to deliver and update our Services as configured and used by You, and to make ongoing personalized experiences and recommendations. -- Troubleshooting: We use Personal Data to identify and resolve technical issues. -- Ongoing Service Performance: Personal Data helps us keep the Services up to date and performant, and meet user productivity, reliability, efficacy, quality, privacy, accessibility and security needs. -- Complying with and resolving legal obligations: including responding to Data Subject Requests for Personal Data processed by GitHub as Controller (for example website data), tax requirements, agreements and disputes. -- Delivering Professional Services: We use Personal Data to deliver training, consulting or implementation (“Professional Services”). This includes providing technical support, professional planning, advice, guidance, data migration, deployment, and solution/software development services. -- Improving Professional Services: Enhancing delivery, efficacy, quality, and security of Professional Services and the underlying product(s) based on issues identified while providing Professional Services, including fixing software defects, and otherwise keeping the Professional Services up to date and performant. +* Business Operations: We use Personal Data for activities like billing, accounting, and compensation. This includes creating aggregated statistical data for internal reporting, financial reporting, revenue planning, capacity planning, and forecast modeling (including product strategy). +* Communication: We use Personal Data to inform you about new Services, features, offers, promotions, and other pertinent information. This also includes sending confirmations, invoices, technical notices, updates, security alerts, and administrative messages. +* Inference: We generate new information from other data we collect to derive likely preferences or other characteristics. For instance, we infer your general geographic location based on your IP address. +* Personalization: We use Personal Data to customize the Service to your preferences, to evaluate the effectiveness of enterprise business ads and promotional communications, and to ensure a seamless and consistent user experience. +* Safety and Security: To promote safety, integrity, and security across our Services, we process Personal Data, using both automated and, at times, manual techniques for abuse detection, prevention, and violations of terms of service. +* Service Provision: We use Personal Data to deliver and update our Services as configured and used by You, and to make ongoing personalized experiences and recommendations. +* Troubleshooting: We use Personal Data to identify and resolve technical issues. +* Ongoing Service Performance: Personal Data helps us keep the Services up to date and performant, and meet user productivity, reliability, efficacy, quality, privacy, accessibility and security needs. +* Complying with and resolving legal obligations: including responding to Data Subject Requests for Personal Data processed by GitHub as Controller (for example website data), tax requirements, agreements and disputes. +* Delivering Professional Services: We use Personal Data to deliver training, consulting or implementation (“Professional Services”). This includes providing technical support, professional planning, advice, guidance, data migration, deployment, and solution/software development services. +* Improving Professional Services: Enhancing delivery, efficacy, quality, and security of Professional Services and the underlying product(s) based on issues identified while providing Professional Services, including fixing software defects, and otherwise keeping the Professional Services up to date and performant. When carrying out these activities, GitHub practices data minimization and uses the minimum amount of Personal Information required. @@ -93,26 +93,26 @@ When carrying out these activities, GitHub practices data minimization and uses We may share Personal Data with the following recipients: -- Abuse and Fraud Prevention Entities: We may disclose Personal Data based on a good faith belief it is needed to prevent fraud, abuse, or attacks on our Services, or to protect the safety of GitHub and our users. -- Affiliates: Personal Data may be shared with GitHub affiliates, including Microsoft, to facilitate customer service, marketing and advertising, order fulfillment, billing, technical support, and legal and compliance obligations. Our affiliates may only use the Personal Data in a manner consistent with this Privacy Statement. -- GitHub Organization Accounts: If an organization adds you to their GitHub account, we might share Personal Data with that organization to fulfill the commercial relationship. In such a case, your use of the Services is protected by a data protection agreement and terms between your organization and GitHub -- Competent Authorities: We may disclose Personal Data to authorized law enforcement, regulators, courts, or other public authorities in response to lawful requests or to protect our rights and safety. Please refer to our [Guidelines for Legal Requests of User Data](https://docs.github.com/en/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data) for more information. -- Corporate Transaction Entities: we might disclose Personal Data within the limits of the law and in accordance with this Privacy Statement for strategic business transactions such as sales or a merger. -- Partners and Resellers: We cooperate with third-parties that offer sales, consulting, support, and technical services for our Services. We may share your data with these partners and resellers where allowed, and with your consent when required. -- Subprocessors and Service Providers: We may use vendors to provide services on our behalf, including hosting, marketing, advertising, social, analytics, support ticketing, credit card processing, or security services. They are bound by contractual obligations to ensure the security, privacy, and confidentiality of your information. Please visit to see our list of Subprocessors. -- Visual Studio Code (GitHub Codespaces): GitHub Codespaces and github.dev offer Visual Studio Code in a web browser, where some telemetry is collected by default. Details on telemetry collection are on the [VS Code website](https://code.visualstudio.com/docs/getstarted/telemetry). To opt out, go to File > Preferences > Settings in the top left menu of VS Code. Opting out will sync this preference across all future web sessions in GitHub Codespaces and github.dev. -- Other Third-party Applications: Upon your instruction, we may share Personal Data with third-party applications available on our Marketplace. You are responsible for the data you instruct us to share with these applications. -- Other Users and the Public: Depending on your account settings, we may share Personal Data with other users of the Services and the public. You control what information is made public. To adjust your settings, visit User Settings in your profile. Please be aware that any information you share in a collaborative context may become publicly accessible. +* Abuse and Fraud Prevention Entities: We may disclose Personal Data based on a good faith belief it is needed to prevent fraud, abuse, or attacks on our Services, or to protect the safety of GitHub and our users. +* Affiliates: Personal Data may be shared with GitHub affiliates, including Microsoft, to facilitate customer service, marketing and advertising, order fulfillment, billing, technical support, and legal and compliance obligations. Our affiliates may only use the Personal Data in a manner consistent with this Privacy Statement. +* GitHub Organization Accounts: If an organization adds you to their GitHub account, we might share Personal Data with that organization to fulfill the commercial relationship. In such a case, your use of the Services is protected by a data protection agreement and terms between your organization and GitHub +* Competent Authorities: We may disclose Personal Data to authorized law enforcement, regulators, courts, or other public authorities in response to lawful requests or to protect our rights and safety. Please refer to our [Guidelines for Legal Requests of User Data](https://docs.github.com/en/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data) for more information. +* Corporate Transaction Entities: we might disclose Personal Data within the limits of the law and in accordance with this Privacy Statement for strategic business transactions such as sales or a merger. +* Partners and Resellers: We cooperate with third-parties that offer sales, consulting, support, and technical services for our Services. We may share your data with these partners and resellers where allowed, and with your consent when required. +* Subprocessors and Service Providers: We may use vendors to provide services on our behalf, including hosting, marketing, advertising, social, analytics, support ticketing, credit card processing, or security services. They are bound by contractual obligations to ensure the security, privacy, and confidentiality of your information. Please visit to see our list of Subprocessors. +* Visual Studio Code (GitHub Codespaces): GitHub Codespaces and github.dev offer Visual Studio Code in a web browser, where some telemetry is collected by default. Details on telemetry collection are on the [VS Code website](https://code.visualstudio.com/docs/getstarted/telemetry). To opt out, go to File > Preferences > Settings in the top left menu of VS Code. Opting out will sync this preference across all future web sessions in GitHub Codespaces and github.dev. +* Other Third-party Applications: Upon your instruction, we may share Personal Data with third-party applications available on our Marketplace. You are responsible for the data you instruct us to share with these applications. +* Other Users and the Public: Depending on your account settings, we may share Personal Data with other users of the Services and the public. You control what information is made public. To adjust your settings, visit User Settings in your profile. Please be aware that any information you share in a collaborative context may become publicly accessible. ## Private repositories: GitHub Access If your GitHub account has private repositories, you control the access to that information. GitHub personnel does not access private repository information without your consent except as provided in this Privacy Statement and for: -- security purposes -- automated scanning or manual review for known vulnerabilities, active malware, or other content known to violate our Terms of Service -- to assist the repository owner with a support matter -- to maintain the integrity of the Services, or -- to comply with our legal obligations if we have reason to believe the contents are in violation of the law. +* security purposes +* automated scanning or manual review for known vulnerabilities, active malware, or other content known to violate our Terms of Service +* to assist the repository owner with a support matter +* to maintain the integrity of the Services, or +* to comply with our legal obligations if we have reason to believe the contents are in violation of the law. GitHub will provide you with notice regarding private repository access unless doing so is prohibited by law or if GitHub acted in response to a security threat or other risk to security. @@ -120,22 +120,22 @@ GitHub will provide you with notice regarding private repository access unless d GitHub processes Personal Data in compliance with the GDPR, ensuring a lawful basis for each processing activity. The basis varies depending on the data type and the context, including how you access the services. Our processing activities typically fall under these lawful bases: -- Contractual Necessity: Processing is required to fulfill our contractual duties to you, in accordance with the GitHub Terms of Service. -- Legal Obligation: We process data when it's necessary to comply with applicable laws or to protect the rights, safety, and property of GitHub, our affiliates, users, or third parties. -- Legitimate Interests: We process data for purposes that are in our legitimate interests, such as securing our Services, communicating with you, and improving our Services. This is done only when these interests are not overridden by your data protection rights or your fundamental rights and freedoms. -- Consent: We process data when you have explicitly consented to such processing. When we rely on consent as the legal basis, you have the right to withdraw your consent for data processing at any time. The procedures for withdrawal are detailed in this Statement and available on our website. +* Contractual Necessity: Processing is required to fulfill our contractual duties to you, in accordance with the GitHub Terms of Service. +* Legal Obligation: We process data when it's necessary to comply with applicable laws or to protect the rights, safety, and property of GitHub, our affiliates, users, or third parties. +* Legitimate Interests: We process data for purposes that are in our legitimate interests, such as securing our Services, communicating with you, and improving our Services. This is done only when these interests are not overridden by your data protection rights or your fundamental rights and freedoms. +* Consent: We process data when you have explicitly consented to such processing. When we rely on consent as the legal basis, you have the right to withdraw your consent for data processing at any time. The procedures for withdrawal are detailed in this Statement and available on our website. ## Your Privacy Rights Depending on your residence location, you may have specific legal rights regarding your Personal Data: -- The right to access the data collected about you -- The right to request detailed information about the specific types of Personal Data we've collected over the past 12 months, including data disclosed for business purposes -- The right to rectify or update inaccurate or incomplete Personal Data under certain circumstances -- The right to erase or limit the processing of your Personal Data under specific conditions -- The right to object to the processing of your Personal Data, as allowed by applicable law -- The right to withdraw consent, where processing is based on your consent -- The right to receive your collected Personal Data in a structured, commonly used, and machine-readable format to facilitate its transfer to another company, where technically feasible +* The right to access the data collected about you +* The right to request detailed information about the specific types of Personal Data we've collected over the past 12 months, including data disclosed for business purposes +* The right to rectify or update inaccurate or incomplete Personal Data under certain circumstances +* The right to erase or limit the processing of your Personal Data under specific conditions +* The right to object to the processing of your Personal Data, as allowed by applicable law +* The right to withdraw consent, where processing is based on your consent +* The right to receive your collected Personal Data in a structured, commonly used, and machine-readable format to facilitate its transfer to another company, where technically feasible To exercise these rights, please send an email to privacy[at]github[dot]com and follow the instructions provided. To verify your identity for security, we may request extra information before addressing your data-related request. Please contact our Data Protection Officer at dpo[at]github[dot]com for any feedback or concerns. Depending on your region, you have the right to complain to your local Data Protection Authority. European users can find authority contacts on the European Data Protection Board website, and UK users on the Information Commissioner’s Office website. @@ -257,15 +257,15 @@ The table below provides additional information about how we use different types 1. **Generally for all websites** You can control the cookies you encounter on the web using a variety of widely-available tools. For example: -- If your browser sends a [Do Not Track](https://en.wikipedia.org/wiki/Do_Not_Track) (DNT) signal, GitHub will not set non-essential cookies and will not load third party resources which set non-essential cookies. -- Many browsers provide cookie controls which may limit the types of cookies you encounter online. Check out the documentation for your browser to learn more. -- If you enable a browser extension designed to block tracking, such as [Privacy Badger](https://en.wikipedia.org/wiki/Privacy_Badger), non-essential cookies set by a website or third parties may be disabled. -- If you enable a browser extension designed to block unwanted content, such as [uBlock Origin](https://en.wikipedia.org/wiki/UBlock_Origin), non-essential cookies will be disabled to the extent that content that sets non-essential cookies will be blocked. -- You may use the Global Privacy Control (GPC) to communicate your privacy preferences. If GitHub detects the GPC signal from your device, GitHub will not share your data (we do not sell your data). To learn more, visit [Global Privacy Control — Take Control Of Your Privacy](https://globalprivacycontrol.org/) -- Advertising controls. Our advertising partners may participate in associations that provide simple ways to opt out of ad targeting, which you can access at: -- United States: [NAI](http://optout.networkadvertising.org) and [DAA](http://optout.aboutads.info/) -- Canada: [Digital Advertising Alliance of Canada](https://youradchoices.ca/) -- Europe: [European Digital Advertising Alliance](http://www.youronlinechoices.com/) +* If your browser sends a [Do Not Track](https://en.wikipedia.org/wiki/Do_Not_Track) (DNT) signal, GitHub will not set non-essential cookies and will not load third party resources which set non-essential cookies. +* Many browsers provide cookie controls which may limit the types of cookies you encounter online. Check out the documentation for your browser to learn more. +* If you enable a browser extension designed to block tracking, such as [Privacy Badger](https://en.wikipedia.org/wiki/Privacy_Badger), non-essential cookies set by a website or third parties may be disabled. +* If you enable a browser extension designed to block unwanted content, such as [uBlock Origin](https://en.wikipedia.org/wiki/UBlock_Origin), non-essential cookies will be disabled to the extent that content that sets non-essential cookies will be blocked. +* You may use the Global Privacy Control (GPC) to communicate your privacy preferences. If GitHub detects the GPC signal from your device, GitHub will not share your data (we do not sell your data). To learn more, visit [Global Privacy Control — Take Control Of Your Privacy](https://globalprivacycontrol.org/) +* Advertising controls. Our advertising partners may participate in associations that provide simple ways to opt out of ad targeting, which you can access at: +* United States: [NAI](http://optout.networkadvertising.org) and [DAA](http://optout.aboutads.info/) +* Canada: [Digital Advertising Alliance of Canada](https://youradchoices.ca/) +* Europe: [European Digital Advertising Alliance](http://www.youronlinechoices.com/) These choices are specific to the browser you are using. If you access our Services from other devices or browsers, take these actions from those systems to ensure your choices apply to the data collected when you use those systems. @@ -277,11 +277,11 @@ This section provides extra information specifically for residents of certain US These rights are common to the US State privacy laws: -- Right to Knowledge and Correction: You have the right to request details on the specific personal information we’ve collected about you and the right to correct inaccurate information. You can exercise this right by contacting us. You can also access and edit basic account information in your settings. -- Right to Know Data Recipients: We share your information with service providers for legitimate business operations, such as data storage and hosting. For more details, please see “Sharing Your Information” below. -- Right to request Deletion: You reserve the right to request the deletion of your data, barring a few exceptions. Such exceptions include circumstances where we are required to retain data to comply with legal obligations, detect fraudulent activity, investigate reports of abuse or other violations of our Terms of Service, or rectify security issues. Upon receiving your verified request, we will promptly delete your personal information (unless an exception applies), and instruct our service providers to do the same. We employ brief retention terms by design. -- Right to a Timely Response: You are allowed to make two free requests in any 12-month period. We commit to responding to your request within 45 days. In complex cases, we may extend our response time by an additional 45 days. -- Non-Discrimination: We will not hold it against you when you exercise any of your rights. On the contrary, we encourage you to review your privacy settings closely and contact us with any questions. +* Right to Knowledge and Correction: You have the right to request details on the specific personal information we’ve collected about you and the right to correct inaccurate information. You can exercise this right by contacting us. You can also access and edit basic account information in your settings. +* Right to Know Data Recipients: We share your information with service providers for legitimate business operations, such as data storage and hosting. For more details, please see “Sharing Your Information” below. +* Right to request Deletion: You reserve the right to request the deletion of your data, barring a few exceptions. Such exceptions include circumstances where we are required to retain data to comply with legal obligations, detect fraudulent activity, investigate reports of abuse or other violations of our Terms of Service, or rectify security issues. Upon receiving your verified request, we will promptly delete your personal information (unless an exception applies), and instruct our service providers to do the same. We employ brief retention terms by design. +* Right to a Timely Response: You are allowed to make two free requests in any 12-month period. We commit to responding to your request within 45 days. In complex cases, we may extend our response time by an additional 45 days. +* Non-Discrimination: We will not hold it against you when you exercise any of your rights. On the contrary, we encourage you to review your privacy settings closely and contact us with any questions. ### Notice of Collection of Personal Information @@ -301,13 +301,13 @@ To opt out of the sharing of your personal information, you can click on the "Do We also make the following disclosures for purposes of compliance with California privacy law: -- We collected the following categories of personal information in the last 12 months: identifiers/contact information, demographic information (such as gender), payment card information associated with you, commercial information, Internet or other electronic network activity information, geolocation data, audio, electronic, visual or similar information, and inferences drawn from the above. -- The sources of personal information from whom we collected are: directly from you, automatically or from third parties. -- The business or commercial purposes of collecting personal information are as summarized above and in our Privacy Statement under Processing Purposes. -- We disclosed the following categories of personal information for a business purpose in the last 12 months: identifiers/contact information, demographic information (such as gender and rough geographic location), payment information, commercial information, Internet or other electronic network activity information, geolocation data, audio, electronic, visual or similar information, and inferences drawn from the above. We disclosed each category to third-party business partners and service providers, third-party sites or platforms such as social networking sites, and other third parties as described in the Sharing of Personal Data section of our Privacy Statement. -- As defined by applicable law, we “shared” the following categories of personal information in the last 12 months: identifiers/contact information, Internet or other electronic network activity information, and inferences drawn from the above. We shared each category to or with advertising networks, data analytics providers, and social networks. -- The business or commercial purpose of sharing personal information is to assist us with marketing, advertising, and audience measurement. -- We do not “sell” or “share” the personal information of known minors under 16 years of age. +* We collected the following categories of personal information in the last 12 months: identifiers/contact information, demographic information (such as gender), payment card information associated with you, commercial information, Internet or other electronic network activity information, geolocation data, audio, electronic, visual or similar information, and inferences drawn from the above. +* The sources of personal information from whom we collected are: directly from you, automatically or from third parties. +* The business or commercial purposes of collecting personal information are as summarized above and in our Privacy Statement under Processing Purposes. +* We disclosed the following categories of personal information for a business purpose in the last 12 months: identifiers/contact information, demographic information (such as gender and rough geographic location), payment information, commercial information, Internet or other electronic network activity information, geolocation data, audio, electronic, visual or similar information, and inferences drawn from the above. We disclosed each category to third-party business partners and service providers, third-party sites or platforms such as social networking sites, and other third parties as described in the Sharing of Personal Data section of our Privacy Statement. +* As defined by applicable law, we “shared” the following categories of personal information in the last 12 months: identifiers/contact information, Internet or other electronic network activity information, and inferences drawn from the above. We shared each category to or with advertising networks, data analytics providers, and social networks. +* The business or commercial purpose of sharing personal information is to assist us with marketing, advertising, and audience measurement. +* We do not “sell” or “share” the personal information of known minors under 16 years of age. #### Shine the Light Act @@ -323,8 +323,8 @@ We value the trust you place in us and are committed to handling your personal i If you live in Colorado, Connecticut, or Virginia you have some additional rights: -- If we deny your rights request, you have the right to appeal that decision. We will provide you with the necessary information to submit an appeal at that time. -- You have the right to opt out of profiling in furtherance of decisions that produce legal or similarly significant effects concerning the consumer. GitHub does not engage in such profiling as defined by Colorado law, so there’s no need to opt out. +* If we deny your rights request, you have the right to appeal that decision. We will provide you with the necessary information to submit an appeal at that time. +* You have the right to opt out of profiling in furtherance of decisions that produce legal or similarly significant effects concerning the consumer. GitHub does not engage in such profiling as defined by Colorado law, so there’s no need to opt out. ### Nevada diff --git a/content/site-policy/security-policies/github-sirt-description-rfc-2350.md b/content/site-policy/security-policies/github-sirt-description-rfc-2350.md index ec1b0fe27ce6..fc406a4068cd 100644 --- a/content/site-policy/security-policies/github-sirt-description-rfc-2350.md +++ b/content/site-policy/security-policies/github-sirt-description-rfc-2350.md @@ -34,9 +34,9 @@ GitHub Security Incident Response Team (SIRT) Subteams: -- Threat Hunting, Operations, and Response (THOR) -- Product Security Incident Response Team (PSIRT) -- Bug Bounty +* Threat Hunting, Operations, and Response (THOR) +* Product Security Incident Response Team (PSIRT) +* Bug Bounty ### 2.2 Address @@ -49,10 +49,10 @@ United States Our team mainly works in the contiguous United States and keeps to these hours: -- EST/EDT -- CST/CDT -- MST/MDT -- PST/PDT +* EST/EDT +* CST/CDT +* MST/MDT +* PST/PDT ### 2.4 Telephone Number @@ -76,8 +76,8 @@ This relays email to the human(s) on duty for GitHub SIRT. GitHub SIRT has a PGP public key: -- Key ID: `78DCCCE9923E5CFB3CAA5D5AB79DBDA3BE944D9E` -- Key expiry: `2025-09-12` +* Key ID: `78DCCCE9923E5CFB3CAA5D5AB79DBDA3BE944D9E` +* Key expiry: `2025-09-12` ```text -----BEGIN PGP PUBLIC KEY BLOCK----- @@ -128,13 +128,13 @@ Our constituency is any individual or organization that uses a GitHub product or Some examples of GitHub products and services are: -- GitHub.com -- GitHub Enterprise Server -- GitHub Actions -- GitHub Desktop -- GitHub CLI -- GitHub API -- npm +* GitHub.com +* GitHub Enterprise Server +* GitHub Actions +* GitHub Desktop +* GitHub CLI +* GitHub API +* npm ### 3.3 Sponsorship and/or Affiliation @@ -174,8 +174,8 @@ GitHub SIRT does not provide incident response services for customers. Every eff GitHub SIRT carries out the following activities for incident triage: -- Security signals are collected and interpreted to determine risk, severity, and priority. -- Investigation as to whether an incident occurred and what its effect and impact was. +* Security signals are collected and interpreted to determine risk, severity, and priority. +* Investigation as to whether an incident occurred and what its effect and impact was. This list is not exhaustive. @@ -183,9 +183,9 @@ This list is not exhaustive. GitHub SIRT carries out the following activities for incident coordination: -- Situational awareness and analysis for stakeholders such as engineering, legal, and support teams. -- Command role with authority to direct resources as required. -- External coordination with affected or involved third-parties. +* Situational awareness and analysis for stakeholders such as engineering, legal, and support teams. +* Command role with authority to direct resources as required. +* External coordination with affected or involved third-parties. This list is not exhaustive. @@ -193,10 +193,10 @@ This list is not exhaustive. GitHub SIRT carries out the following activities for incident resolution: -- Engages relevant internal teams to eradicate, restore, and secure. -- Collection and storage of evidence for internal use as well as potential law enforcement involvement. -- Notification to affected constituents. -- Postmortem authoring with lessons learned and post-incident repair items. +* Engages relevant internal teams to eradicate, restore, and secure. +* Collection and storage of evidence for internal use as well as potential law enforcement involvement. +* Notification to affected constituents. +* Postmortem authoring with lessons learned and post-incident repair items. This list is not exhaustive. diff --git a/content/site-policy/site-policy-deprecated/github-enterprise-server-license-agreement.md b/content/site-policy/site-policy-deprecated/github-enterprise-server-license-agreement.md index de696158e83f..702cfc241551 100644 --- a/content/site-policy/site-policy-deprecated/github-enterprise-server-license-agreement.md +++ b/content/site-policy/site-policy-deprecated/github-enterprise-server-license-agreement.md @@ -13,11 +13,11 @@ _These terms apply to Customers who have executed agreements in place referencin This Agreement applies to the following GitHub offerings, as further defined below (collectively, the **“Products”**): -- The Software (which may include Add-on Software, such as Advanced Security, Insights and Learning Lab for Enterprise Server); +* The Software (which may include Add-on Software, such as Advanced Security, Insights and Learning Lab for Enterprise Server); -- Any related Support; and +* Any related Support; and -- Any related Professional Services. +* Any related Professional Services. If Customer has purchased the Products from a GitHub Partner, the following provisions of this Agreement will be superseded by the terms between Customer and the GitHub Partner: Section 8, Payment; Section 9, Delivery; Section 10, Verification; and Section 17, Term and Termination. diff --git a/content/site-policy/site-policy-deprecated/github-enterprise-subscription-agreement.md b/content/site-policy/site-policy-deprecated/github-enterprise-subscription-agreement.md index e036caa7a617..97ba200446f1 100644 --- a/content/site-policy/site-policy-deprecated/github-enterprise-subscription-agreement.md +++ b/content/site-policy/site-policy-deprecated/github-enterprise-subscription-agreement.md @@ -14,23 +14,23 @@ _These terms apply to Customers who have executed agreements in place referencin This Agreement applies to the following GitHub offerings, as further defined below (collectively, the **"Products"**): -- GitHub Enterprise (comprised of GitHub Enterprise Server, which may include Add-On Software, and GitHub Enterprise Cloud); +* GitHub Enterprise (comprised of GitHub Enterprise Server, which may include Add-On Software, and GitHub Enterprise Cloud); -- Any Beta Previews; +* Any Beta Previews; -- Any related Support; and +* Any related Support; and -- Any related Professional Services. +* Any related Professional Services. This Agreement includes the following Sections and Exhibits, each of which is incorporated by reference herein: -- SECTION 1: General Terms and Conditions; +* SECTION 1: General Terms and Conditions; -- SECTION 2: GitHub Enterprise Server License Terms; +* SECTION 2: GitHub Enterprise Server License Terms; -- SECTION 3: GitHub Enterprise Cloud Terms of Service; +* SECTION 3: GitHub Enterprise Cloud Terms of Service; -- EXHIBIT A: Definitions. +* EXHIBIT A: Definitions. If Customer has purchased any Products from an authorized GitHub reseller, the following Sections of this Agreement are superseded by the terms Customer has agreed upon with the GitHub reseller: Section 1.1 (Term and Termination); 1.2 (Payment); Section 2.3 (Delivery); and Section 2.4 (Verification). diff --git a/content/site-policy/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md b/content/site-policy/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md index abaae7a72ccc..997ae61a58d7 100644 --- a/content/site-policy/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md +++ b/content/site-policy/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md @@ -16,21 +16,21 @@ The following GitHub Supplemental Terms (including any applicable Order Forms) s These Supplemental Terms apply to the following GitHub Offerings, as further defined below (collectively, the "**Products**"): -- GitHub Enterprise (comprised of GitHub Enterprise Server, which may include Add-on Software, and GitHub Enterprise Cloud); +* GitHub Enterprise (comprised of GitHub Enterprise Server, which may include Add-on Software, and GitHub Enterprise Cloud); -- Any related Support; and +* Any related Support; and -- Any related Professional Services. +* Any related Professional Services. These GitHub Supplemental Terms include the following Sections and Exhibits, each of which is incorporated by reference herein: -- SECTION 1: GitHub Enterprise Server License Terms; +* SECTION 1: GitHub Enterprise Server License Terms; -- SECTION 2: GitHub Enterprise Cloud Terms of Service; +* SECTION 2: GitHub Enterprise Cloud Terms of Service; -- SECTION 3: General Provisions; and +* SECTION 3: General Provisions; and -- EXHIBIT A: Definitions. +* EXHIBIT A: Definitions. ## SECTION 1: GITHUB ENTERPRISE SERVER LICENSE TERMS diff --git a/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md b/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md index ba70807434b3..6c42452b0190 100644 --- a/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md +++ b/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md @@ -157,8 +157,8 @@ Anyone in any region can sponsor eligible maintainers, but you must reside in a ## Further reading -- "[AUTOTITLE](/sponsors/sponsoring-open-source-contributors)" -- "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors)" -- "[AUTOTITLE](/search-github/searching-on-github/searching-users#search-based-on-ability-to-sponsor)" -- "[AUTOTITLE](/search-github/searching-on-github/searching-for-repositories#search-based-on-ability-to-sponsor)" -- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} +* "[AUTOTITLE](/sponsors/sponsoring-open-source-contributors)" +* "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors)" +* "[AUTOTITLE](/search-github/searching-on-github/searching-users#search-based-on-ability-to-sponsor)" +* "[AUTOTITLE](/search-github/searching-on-github/searching-for-repositories#search-based-on-ability-to-sponsor)" +* "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md b/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md index 32e05fdd579e..d44e7d4fba2f 100644 --- a/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md +++ b/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md @@ -25,16 +25,16 @@ You can see whom a user or organization sponsors on their {% data variables.prod ## Consider how you benefit from different contributions Consider whether you benefit from the work of open source contributions, such as: -- Documentation -- Design -- Translation -- Newsletters -- Code reviews -- Tutorials -- Mentoring -- Triaging issues and helping with project management -- Answering questions -- Event planning +* Documentation +* Design +* Translation +* Newsletters +* Code reviews +* Tutorials +* Mentoring +* Triaging issues and helping with project management +* Answering questions +* Event planning For more information on different types of open source contributions, see the [Open source guide](https://opensource.guide/how-to-contribute/#you-dont-have-to-contribute-code). diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md index afb4d12ec786..2668701c068c 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md @@ -46,4 +46,4 @@ For more information, see "[AUTOTITLE](/sponsors/receiving-sponsorships-through- ## Further reading -- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} +* "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors.md index a16f74c20c9e..317bbda0d873 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors.md @@ -19,8 +19,8 @@ shortTitle: Edit profile details Your {% data variables.product.prodname_sponsors %} profile tells potential sponsors why they should support you. People see your sponsor profile when they click the **Sponsor** button on your profile. We recommend including the following information. -- Open source work that you contribute to -- Why you are committed to open source development +* Open source work that you contribute to +* Why you are committed to open source development ## Editing your profile details diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/enabling-sponsorships-through-patreon.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/enabling-sponsorships-through-patreon.md index d927ad1f1178..6815950ba97f 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/enabling-sponsorships-through-patreon.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/enabling-sponsorships-through-patreon.md @@ -13,11 +13,11 @@ shortTitle: Enable Patreon sponsorships ## Prerequisites -- Create a Patreon account. For more information, see [Start my creator page on Patreon](https://support.patreon.com/hc/en-us/articles/115002958403-Start-my-creator-page-on-Patreon) in the Patreon documentation. -- Set up a paid membership tier on Patreon. For more information, see [How to set up paid tiers and benefits](https://support.patreon.com/hc/en-us/articles/203913559-How-to-set-up-paid-tiers-and-benefits) in the Patreon documentation. -- Publish your Patreon creator page and tiers. -- Link your Patreon account to your {% data variables.product.prodname_dotcom %} account. For more information, see "[Linking your Patreon account to your {% data variables.product.prodname_dotcom %} account](#linking-your-patreon-account-to-your-github-account)." -- Set up {% data variables.product.prodname_sponsors %} for your personal account or for your organization. For more information, see "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account)" or "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." +* Create a Patreon account. For more information, see [Start my creator page on Patreon](https://support.patreon.com/hc/en-us/articles/115002958403-Start-my-creator-page-on-Patreon) in the Patreon documentation. +* Set up a paid membership tier on Patreon. For more information, see [How to set up paid tiers and benefits](https://support.patreon.com/hc/en-us/articles/203913559-How-to-set-up-paid-tiers-and-benefits) in the Patreon documentation. +* Publish your Patreon creator page and tiers. +* Link your Patreon account to your {% data variables.product.prodname_dotcom %} account. For more information, see "[Linking your Patreon account to your {% data variables.product.prodname_dotcom %} account](#linking-your-patreon-account-to-your-github-account)." +* Set up {% data variables.product.prodname_sponsors %} for your personal account or for your organization. For more information, see "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account)" or "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." ## Linking your Patreon account to your {% data variables.product.prodname_dotcom %} account diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md index aa54dbf3dc9c..90dcbf6f6275 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md @@ -26,8 +26,8 @@ shortTitle: Manage payment tiers {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.navigate-to-sponsor-tiers-tab %} 1. If you are setting up tiers for the first time, we recommend you review the suggested tier examples to see how some other open source contributors have set up {% data variables.product.prodname_sponsors %}. Decide whether you want to start with some suggested draft tiers, which you can customize in the tier editor. - - To use a suggested tier, select the rewards you'd like to include in your draft tier or tiers. Then, click **Continue to tier editor**. - - To create tiers without using with any of the draft suggestions, click **Skip this step**. + * To use a suggested tier, select the rewards you'd like to include in your draft tier or tiers. Then, click **Continue to tier editor**. + * To create tiers without using with any of the draft suggestions, click **Skip this step**. 1. Optionally, in the text boxes in the "Custom amounts" section, type a recommended or minimum sponsorship amount. The minimum amount applies to both recurring and one-time sponsorships. 1. Optionally, to edit a draft tier, find the draft tier and click **Edit**. @@ -70,9 +70,9 @@ You can also manually add or remove collaborators to the repository, and {% data If you transfer a repository that has been added to a sponsorship tier, sponsors who have access to the repository through the tier may be affected. -- If the sponsored profile is for an organization and the repository is transferred to a different organization, current sponsors will be transferred, but new sponsors will not be added. The new owner of the repository can remove existing sponsors. -- If the sponsored profile is for a personal account, the repository is transferred to an organization, and the personal account has admin access to the new repository, existing sponsors will be transferred, and new sponsors will continue to be added to the repository. -- If the repository is transferred to a personal account, all sponsors will be removed and new sponsors will not be added to the repository. +* If the sponsored profile is for an organization and the repository is transferred to a different organization, current sponsors will be transferred, but new sponsors will not be added. The new owner of the repository can remove existing sponsors. +* If the sponsored profile is for a personal account, the repository is transferred to an organization, and the personal account has admin access to the new repository, existing sponsors will be transferred, and new sponsors will continue to be added to the repository. +* If the repository is transferred to a personal account, all sponsors will be removed and new sponsors will not be added to the repository. ### Adding a repository a sponsorship tier diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md index ec1888c8f07f..eaf0f7611460 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md @@ -92,5 +92,5 @@ Before your organization can become a sponsored organization, you must enable 2F ## Further reading -- "[AUTOTITLE](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" -- "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors)" +* "[AUTOTITLE](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" +* "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors)" diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md index 1703e9455890..55ff18b6c77b 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md @@ -73,4 +73,4 @@ In the EU and most other countries and regions, B2C sales are subject to sales t ## Further reading -- "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships)" +* "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships)" diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/unpublishing-your-github-sponsors-profile.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/unpublishing-your-github-sponsors-profile.md index 523ae753c2a9..532b3ae96dbd 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/unpublishing-your-github-sponsors-profile.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/unpublishing-your-github-sponsors-profile.md @@ -14,8 +14,8 @@ shortTitle: Unpublish your profile If you have sponsors, you'll need to contact GitHub Support to help you unpublish your {% data variables.product.prodname_sponsors %} account. After your {% data variables.product.prodname_sponsors %} account is unpublished: -- You'll no longer receive sponsorship payments. -- You can request to re-publish your profile. +* You'll no longer receive sponsorship payments. +* You can request to re-publish your profile. {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.settings-tab %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts.md index c322fb9e1295..a269fa85ea0e 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts.md @@ -19,10 +19,10 @@ When you sign up for a {% data variables.product.prodname_sponsors %} profile so {% data variables.product.prodname_sponsors %} supports these fiscal hosts: -- [Open Source Collective](https://opencollective.com/opensource) -- [NumFOCUS](https://www.numfocus.org/) -- [Open Collective Europe](https://opencollective.com/europe) -- [Software Underground](https://softwareunderground.org/) +* [Open Source Collective](https://opencollective.com/opensource) +* [NumFOCUS](https://www.numfocus.org/) +* [Open Collective Europe](https://opencollective.com/europe) +* [Software Underground](https://softwareunderground.org/) ## Choosing to use a fiscal host diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md index ba5bd703b045..ee3d3ddcf9ee 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md @@ -24,8 +24,8 @@ To track where your sponsorships are coming from, you can use custom URLs with m Metadata must use the `key=value` format and can be added to the end of these URLs. -- Sponsored account profile: `https://github.com/sponsors/{account}` -- Sponsorship checkout: `https://github.com/sponsors/{account}/sponsorships` +* Sponsored account profile: `https://github.com/sponsors/{account}` +* Sponsorship checkout: `https://github.com/sponsors/{account}/sponsorships` The metadata will persist in the URL as a potential sponsor switches accounts to sponsor with, selects monthly or one-time payments, and chooses a different tier. @@ -33,12 +33,12 @@ The metadata will persist in the URL as a potential sponsor switches accounts to Your metadata must meet the following requirements, which do not apply to any other URL parameters that are passed. -- Keys must be prefixed by `metadata_`, such as `metadata_campaign`. In your transaction export, the `metadata_` prefix will be removed from the key. -- Keys and values must only contain alphanumeric values, dashes, or underscores. If non-accepted characters are passed in either keys or values, a 404 error will be presented. -- Whitespaces are not allowed. -- A maximum of **10** key-value pairs are accepted per request. If more are passed, only the first 10 will be saved. -- A maximum of **25** characters per key are accepted. If more than that are passed, only the first 25 will be saved. -- A maximum of **100** characters per value are accepted. If more than that are passed, only the first 100 will be saved. +* Keys must be prefixed by `metadata_`, such as `metadata_campaign`. In your transaction export, the `metadata_` prefix will be removed from the key. +* Keys and values must only contain alphanumeric values, dashes, or underscores. If non-accepted characters are passed in either keys or values, a 404 error will be presented. +* Whitespaces are not allowed. +* A maximum of **10** key-value pairs are accepted per request. If more are passed, only the first 10 will be saved. +* A maximum of **25** characters per key are accepted. If more than that are passed, only the first 25 will be saved. +* A maximum of **100** characters per value are accepted. If more than that are passed, only the first 100 will be saved. For example, you can use `https://github.com/sponsors/{account}?metadata_campaign=myblog` to track sponsorships that originate from your blog. `metadata_campaign` is the key and `myblog` is the value. In the metadata column of your transaction export, the key will be listed as `campaign`. diff --git a/content/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes.md b/content/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes.md index 4e9d783e2bef..a6ff4eba471d 100644 --- a/content/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes.md +++ b/content/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes.md @@ -18,10 +18,10 @@ allowTitleToDifferFromFilename: true {% data reusables.sponsors.sponsorship-details %} You can sponsor an account on behalf of your personal account to invest in projects that you personally benefit from. You can sponsor an account on behalf of your organization for many reasons. -- Sustaining specific libraries that your organization's work depends on -- Investing in the ecosystem you rely on as an organization (such as blockchain) -- Developing brand awareness as an organization that values open source -- Thanking open source developers for building libraries that complement the product your organization offers +* Sustaining specific libraries that your organization's work depends on +* Investing in the ecosystem you rely on as an organization (such as blockchain) +* Developing brand awareness as an organization that values open source +* Thanking open source developers for building libraries that complement the product your organization offers We may share certain limited tax information with sponsored accounts. For more information, see "[Tax information](#tax-information)." @@ -40,8 +40,8 @@ If the account you want to sponsor does not have a profile on {% data variables. ## About payment methods for sponsorships You can pay for sponsorships: -- With a credit card. For more information, see "[AUTOTITLE](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github)." -- Through Patreon. For more information, see "[AUTOTITLE](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-patreon)." +* With a credit card. For more information, see "[AUTOTITLE](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github)." +* Through Patreon. For more information, see "[AUTOTITLE](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-patreon)." {% note %} @@ -67,10 +67,10 @@ For more information on fees and billing, see "[AUTOTITLE](/billing/managing-bil As a sponsor, you acknowledge that we may disclose to the owner of each account you sponsor the following limited information about your sponsorship payments to the account, since the inception of the Sponsors Program: -- Transaction date -- Amount paid -- The country, state, and province from where payment was made -- Whether payment was made by a business or individual +* Transaction date +* Amount paid +* The country, state, and province from where payment was made +* Whether payment was made by a business or individual This information is necessary to enable payment and reporting of any taxes arising from such sponsorship payments. diff --git a/content/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship.md b/content/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship.md index 539c231354f9..147a9d5104a5 100644 --- a/content/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship.md +++ b/content/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship.md @@ -36,5 +36,5 @@ You can choose whether an account you sponsor can send you email updates about t ## Further reading -- "[AUTOTITLE](/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship)" -- "[AUTOTITLE](/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship)" +* "[AUTOTITLE](/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship)" +* "[AUTOTITLE](/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship)" diff --git a/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md b/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md index ea9b32e00dd7..75bf6b3dff54 100644 --- a/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md +++ b/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md @@ -25,9 +25,9 @@ When setting up a sponsorship, organizations paying by invoice have the option t ### Requirements -- The organization needs to sign the sponsorship agreement which is a 3 year commitment. The {% data variables.product.company_short %} Invoiced Sponsor Agreement is separate from other services. -- The organization needs a minimum spend of 5,000 US dollars (USD) per year on sponsoring. -- The organization needs to pay the invoice within 30 days. +* The organization needs to sign the sponsorship agreement which is a 3 year commitment. The {% data variables.product.company_short %} Invoiced Sponsor Agreement is separate from other services. +* The organization needs a minimum spend of 5,000 US dollars (USD) per year on sponsoring. +* The organization needs to pay the invoice within 30 days. Once the organization reaches the yearly minimum spend, they can opt out of being invoiced for the rest of the year. diff --git a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github.md b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github.md index e609d985b5de..4608f615ee3f 100644 --- a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github.md +++ b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github.md @@ -67,9 +67,9 @@ Before you can sponsor an account, you must have a verified email address. For m Alternatively, drag and drop your CSV file into the "Import a CSV" box. You can sponsor in bulk with any of the following files: - - The previously mentioned CSV file of developers who maintain your account's or organization's dependencies. - - {% data variables.product.prodname_dotcom %}'s template CSV file for bulk sponsorships edited to contain your desired sponsorships. To download the example CSV file, in the "Import a CSV" box, click **Download example CSV**. - - A CSV file of your own creation containing your desired sponsorships. For {% data variables.product.prodname_dotcom %} to parse your CSV file correctly, the file must contain columns labeled "Maintainer username" and "Sponsorship amount in USD." + * The previously mentioned CSV file of developers who maintain your account's or organization's dependencies. + * {% data variables.product.prodname_dotcom %}'s template CSV file for bulk sponsorships edited to contain your desired sponsorships. To download the example CSV file, in the "Import a CSV" box, click **Download example CSV**. + * A CSV file of your own creation containing your desired sponsorships. For {% data variables.product.prodname_dotcom %} to parse your CSV file correctly, the file must contain columns labeled "Maintainer username" and "Sponsorship amount in USD." {% note %} diff --git a/content/support/contacting-github-support/creating-a-support-ticket.md b/content/support/contacting-github-support/creating-a-support-ticket.md index e03c5948e420..078803108b7e 100644 --- a/content/support/contacting-github-support/creating-a-support-ticket.md +++ b/content/support/contacting-github-support/creating-a-support-ticket.md @@ -54,13 +54,13 @@ After you create your ticket, you can view your ticket and the responses from {% {% data variables.contact.github_support %} does not have access to any private or internal {% data variables.product.company_short %} resources. Providing {% data variables.contact.github_support %} with everything they need to understand, locate, and reproduce an issue will allow for a faster resolution and less back-and-forth between yourself and the support team. To ensure {% data variables.contact.github_support %} can assist you, consider the following points when you write your ticket: -- Obtain information that can help {% data variables.contact.github_support %} track, prioritize, reproduce, or investigate the issue. -- Include full URLs, repository names, and usernames wherever possible. -- Reproduce the issue if applicable and be prepared to share the steps. -- Be prepared to provide a full description of the issue and expected results. -- Copy exact wording of all error messages related to your issue. -- Determine if there is an existing ticket number in any ongoing communications with {% data variables.contact.github_support %}. -- Include relevant logs and attach any screenshots that demonstrate the issue. +* Obtain information that can help {% data variables.contact.github_support %} track, prioritize, reproduce, or investigate the issue. +* Include full URLs, repository names, and usernames wherever possible. +* Reproduce the issue if applicable and be prepared to share the steps. +* Be prepared to provide a full description of the issue and expected results. +* Copy exact wording of all error messages related to your issue. +* Determine if there is an existing ticket number in any ongoing communications with {% data variables.contact.github_support %}. +* Include relevant logs and attach any screenshots that demonstrate the issue. {% ifversion ghes %} @@ -68,10 +68,10 @@ After you create your ticket, you can view your ticket and the responses from {% Especially for tickets with {% data variables.product.support_ticket_priority_urgent %} priority, the person contacting {% data variables.contact.github_support %} should: -- Be knowledgeable in your internal systems, tools, policies, and practices. -- Be a proficient user of {% data variables.product.product_name %}. -- Have full access and permissions to any services that are required to troubleshoot the issue. -- Be authorized to make the recommended changes to your network and any applicable products. +* Be knowledgeable in your internal systems, tools, policies, and practices. +* Be a proficient user of {% data variables.product.product_name %}. +* Have full access and permissions to any services that are required to troubleshoot the issue. +* Be authorized to make the recommended changes to your network and any applicable products. {% endif %} @@ -85,9 +85,9 @@ Especially for tickets with {% data variables.product.support_ticket_priority_ur 1. Navigate to the {% data variables.contact.contact_landing_page_portal %} and choose one of the following options: - - To sign in with your {% data variables.product.prodname_dotcom %} account, click **Sign in with {% data variables.product.prodname_dotcom %}**. - - To sign up for {% data variables.product.prodname_dotcom %}, click **Sign up for {% data variables.product.prodname_dotcom %}**. - - If you can't sign in or sign up, click **Can't sign in?** and fill out the form. You will be guided through an email verification process.{% ifversion ghec or ghes %} You will need to upload your {% data variables.product.prodname_enterprise %} license. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)."{% endif %} + * To sign in with your {% data variables.product.prodname_dotcom %} account, click **Sign in with {% data variables.product.prodname_dotcom %}**. + * To sign up for {% data variables.product.prodname_dotcom %}, click **Sign up for {% data variables.product.prodname_dotcom %}**. + * If you can't sign in or sign up, click **Can't sign in?** and fill out the form. You will be guided through an email verification process.{% ifversion ghec or ghes %} You will need to upload your {% data variables.product.prodname_enterprise %} license. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)."{% endif %} {% data reusables.support.submit-a-ticket %} @@ -102,9 +102,9 @@ Especially for tickets with {% data variables.product.support_ticket_priority_ur 1. Choose one of the following options: - - To sign in with your {% data variables.product.prodname_dotcom %} account, click **Sign in with {% data variables.product.prodname_dotcom %}**. - - To sign up for {% data variables.product.prodname_dotcom %}, click **Sign up for {% data variables.product.prodname_dotcom %}**. - - If you can't sign in or sign up, click **Can't sign in?** and fill out the form. You will be guided through an email verification process. You will need to upload your {% data variables.product.prodname_enterprise %} license. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)." + * To sign in with your {% data variables.product.prodname_dotcom %} account, click **Sign in with {% data variables.product.prodname_dotcom %}**. + * To sign up for {% data variables.product.prodname_dotcom %}, click **Sign up for {% data variables.product.prodname_dotcom %}**. + * If you can't sign in or sign up, click **Can't sign in?** and fill out the form. You will be guided through an email verification process. You will need to upload your {% data variables.product.prodname_enterprise %} license. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)." 1. If you'd like to include diagnostics with your support ticket, Under "Diagnostics", click **Download diagnostic info** and save the file locally. You'll attach this file to your support ticket later. 1. To complete your ticket and display the {% data variables.contact.enterprise_portal %}, under "Open Support Request", click **New support request**. @@ -114,4 +114,4 @@ Especially for tickets with {% data variables.product.support_ticket_priority_ur ## Further reading -- "[AUTOTITLE](/support/learning-about-github-support/about-github-support)" +* "[AUTOTITLE](/support/learning-about-github-support/about-github-support)" diff --git a/content/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal.md b/content/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal.md index 4262bbc34129..ddaae1a068ba 100644 --- a/content/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal.md +++ b/content/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal.md @@ -28,9 +28,9 @@ To benefit from Premium Support SLAs and ticket collaboration features, you must 1. If your institution has an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, you have a user account on {% data variables.product.prodname_dotcom_the_website %}, and that user account has been granted support entitlements for the enterprise account, you can select the enterprise account when creating a ticket. For more information about enterprise accounts, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." - - The majority of {% data variables.product.prodname_ghe_server %} customers already have an enterprise account on {% data variables.product.prodname_dotcom_the_website %}. If you're not sure whether you do, first check with your team. - - If your team confirms that you do not have an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, you can [submit a request](https://support.github.com/contact?comments=%3E+Please+provide+the+following+information+and+someone+will+be+in+touch+to+help+you+setup+your+enterprise+account.%0A%0A%23%23%23%23+Company+name+%28required%29%0A%0A%23%23%23%23+Email+address+or+GitHub+login+of+the+person+who+should+be+the+initial+owner+of+the+enterprise+account+%28required%29%0A%0A%23%23%23%23+Is+there+anything+else+we+should+know+to+help+us+identify+your+account%3F+%28optional%29%0A%3E+Attaching+a+GitHub+Enterprise+Server+diagnostics+file+here+can+help+us+identify+your+account+by+license+reference+number%0A%0A&subject=Enterprise+Account+Request&tags=new-ea) for a new one. - - Then, for the best experience, follow the steps below before using the {% data variables.contact.contact_landing_page_portal %} to create tickets about the enterprise account. + * The majority of {% data variables.product.prodname_ghe_server %} customers already have an enterprise account on {% data variables.product.prodname_dotcom_the_website %}. If you're not sure whether you do, first check with your team. + * If your team confirms that you do not have an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, you can [submit a request](https://support.github.com/contact?comments=%3E+Please+provide+the+following+information+and+someone+will+be+in+touch+to+help+you+setup+your+enterprise+account.%0A%0A%23%23%23%23+Company+name+%28required%29%0A%0A%23%23%23%23+Email+address+or+GitHub+login+of+the+person+who+should+be+the+initial+owner+of+the+enterprise+account+%28required%29%0A%0A%23%23%23%23+Is+there+anything+else+we+should+know+to+help+us+identify+your+account%3F+%28optional%29%0A%3E+Attaching+a+GitHub+Enterprise+Server+diagnostics+file+here+can+help+us+identify+your+account+by+license+reference+number%0A%0A&subject=Enterprise+Account+Request&tags=new-ea) for a new one. + * Then, for the best experience, follow the steps below before using the {% data variables.contact.contact_landing_page_portal %} to create tickets about the enterprise account. 1. If you're sure you do not have an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, you have not been configured as a support-entitled member by an enterprise owner, or you cannot sign in with to your {% data variables.product.prodname_dotcom_the_website %} account, you can provide a copy of your license key or diagnostics file by using the [Get help with {% data variables.product.prodname_ghe_server %}](https://support.github.com/contact/enterprise-by-license) form. diff --git a/content/support/contacting-github-support/providing-data-to-github-support.md b/content/support/contacting-github-support/providing-data-to-github-support.md index f383017957e8..10d95f852558 100644 --- a/content/support/contacting-github-support/providing-data-to-github-support.md +++ b/content/support/contacting-github-support/providing-data-to-github-support.md @@ -30,32 +30,32 @@ To help you troubleshoot issues with a {% data variables.product.prodname_ghe_se Authentication tokens, keys, and secrets are removed from log files in the following log directories contained within a support bundle or diagnostics file: -- `alambic-logs` -- `babeld-logs` -- `codeload-logs` -- `enterprise-manage-logs` -- `github-logs` -- `hookshot-logs` -- `lfs-server-logs` -- `semiotic-logs` -- `task-dispatcher-logs` -- `pages-logs` -- `registry-logs` -- `render-logs` -- `svn-bridge-logs` +* `alambic-logs` +* `babeld-logs` +* `codeload-logs` +* `enterprise-manage-logs` +* `github-logs` +* `hookshot-logs` +* `lfs-server-logs` +* `semiotic-logs` +* `task-dispatcher-logs` +* `pages-logs` +* `registry-logs` +* `render-logs` +* `svn-bridge-logs` ## Creating and sharing diagnostic files Diagnostic files are an overview of a {% data variables.product.prodname_ghe_server %} instance's settings and environment that contain: -- Client license information, including company name, expiration date, and number of user licenses -- Version numbers and SHAs -- VM architecture -- Host name, private mode, SSL settings -- Load and process listings -- Network settings -- Authentication method and details -- Number of repositories, users, and other installation data +* Client license information, including company name, expiration date, and number of user licenses +* Version numbers and SHAs +* VM architecture +* Host name, private mode, SSL settings +* Load and process listings +* Network settings +* Authentication method and details +* Number of repositories, users, and other installation data You can download the diagnostics for your instance from the {% data variables.enterprise.management_console %} or by running the `ghe-diagnostics` command-line utility. @@ -83,18 +83,18 @@ ssh -p122 admin@HOSTNAME -- 'ghe-diagnostics' > diagnostics.txt After you submit your support request, we may ask you to share a support bundle with our team. The support bundle is a gzip-compressed tar archive that includes diagnostics and important logs from your instance, such as: -- Authentication-related logs that may be helpful when troubleshooting authentication errors, or configuring LDAP, CAS, or SAML -- {% data variables.enterprise.management_console %} log -- `github-logs/exceptions.log`: Information about 500 errors encountered on the site -- `github-logs/audit.log`: {% data variables.product.prodname_ghe_server %} audit logs -- `babeld-logs/babeld.log`: Git proxy logs -- `system-logs/haproxy.log`: HAProxy logs -- `elasticsearch-logs/github-enterprise.log`: Elasticsearch logs -- `configuration-logs/{% ifversion unique-config-run-logs %}{% else %}ghe-config.log{% endif %}`: {% data variables.product.prodname_ghe_server %} configuration logs +* Authentication-related logs that may be helpful when troubleshooting authentication errors, or configuring LDAP, CAS, or SAML +* {% data variables.enterprise.management_console %} log +* `github-logs/exceptions.log`: Information about 500 errors encountered on the site +* `github-logs/audit.log`: {% data variables.product.prodname_ghe_server %} audit logs +* `babeld-logs/babeld.log`: Git proxy logs +* `system-logs/haproxy.log`: HAProxy logs +* `elasticsearch-logs/github-enterprise.log`: Elasticsearch logs +* `configuration-logs/{% ifversion unique-config-run-logs %}{% else %}ghe-config.log{% endif %}`: {% data variables.product.prodname_ghe_server %} configuration logs {%- ifversion unique-config-run-logs %} {%- endif %} -- `collectd/logs/collectd.log`: Collectd logs -- `mail-logs/mail.log`: SMTP email delivery logs +* `collectd/logs/collectd.log`: Collectd logs +* `mail-logs/mail.log`: SMTP email delivery logs For more information, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise)." @@ -149,8 +149,8 @@ You can use these steps to create and share a support bundle if you have SSH acc ### Uploading a support bundle directly using SSH You can directly upload a support bundle to our server if: -- You have SSH access to {% data variables.location.product_location %}. -- Outbound HTTPS connections over TCP port 443 are allowed from {% data variables.location.product_location %} to _enterprise-bundles.github.com_ and _esbtoolsproduction.blob.core.windows.net_. +* You have SSH access to {% data variables.location.product_location %}. +* Outbound HTTPS connections over TCP port 443 are allowed from {% data variables.location.product_location %} to _enterprise-bundles.github.com_ and _esbtoolsproduction.blob.core.windows.net_. 1. Upload the bundle to our support bundle server: @@ -180,8 +180,8 @@ You can use these steps to create and share an extended support bundle if you ha ### Uploading an extended support bundle directly using SSH You can directly upload a support bundle to our server if: -- You have SSH access to {% data variables.location.product_location %}. -- Outbound HTTPS connections over TCP port 443 are allowed from {% data variables.location.product_location %} to _enterprise-bundles.github.com_ and _esbtoolsproduction.blob.core.windows.net_. +* You have SSH access to {% data variables.location.product_location %}. +* Outbound HTTPS connections over TCP port 443 are allowed from {% data variables.location.product_location %} to _enterprise-bundles.github.com_ and _esbtoolsproduction.blob.core.windows.net_. 1. Upload the bundle to our support bundle server: @@ -191,5 +191,5 @@ You can directly upload a support bundle to our server if: ## Further reading -- "[AUTOTITLE](/support/learning-about-github-support/about-github-support)" -- "[AUTOTITLE](/enterprise-server@latest/admin/enterprise-management/monitoring-your-appliance/generating-a-health-check-for-your-enterprise)" +* "[AUTOTITLE](/support/learning-about-github-support/about-github-support)" +* "[AUTOTITLE](/enterprise-server@latest/admin/enterprise-management/monitoring-your-appliance/generating-a-health-check-for-your-enterprise)" diff --git a/content/support/contacting-github-support/viewing-and-updating-support-tickets.md b/content/support/contacting-github-support/viewing-and-updating-support-tickets.md index 9fc56d84cf7b..72721cffa1fa 100644 --- a/content/support/contacting-github-support/viewing-and-updating-support-tickets.md +++ b/content/support/contacting-github-support/viewing-and-updating-support-tickets.md @@ -75,4 +75,4 @@ If your account includes {% data variables.contact.premium_support %}, you can r ## Further reading -- "[AUTOTITLE](/support/learning-about-github-support/about-github-support)" +* "[AUTOTITLE](/support/learning-about-github-support/about-github-support)" diff --git a/content/support/learning-about-github-support/about-copilot-in-github-support.md b/content/support/learning-about-github-support/about-copilot-in-github-support.md index 9786b1dbdbd6..aac0360d8d0a 100644 --- a/content/support/learning-about-github-support/about-copilot-in-github-support.md +++ b/content/support/learning-about-github-support/about-copilot-in-github-support.md @@ -63,5 +63,5 @@ We greatly value your feedback. As we continuously improve {% data variables.pro ## Further reading -- "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)" -- "[AUTOTITLE](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement)" +* "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)" +* "[AUTOTITLE](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement)" diff --git a/content/support/learning-about-github-support/about-github-premium-support.md b/content/support/learning-about-github-support/about-github-premium-support.md index 069ba13daa97..530e377332c1 100644 --- a/content/support/learning-about-github-support/about-github-premium-support.md +++ b/content/support/learning-about-github-support/about-github-premium-support.md @@ -26,9 +26,9 @@ topics: **Notes:** -- The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of November 2021. +* The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of November 2021. -- {% data reusables.support.data-protection-and-privacy %} +* {% data reusables.support.data-protection-and-privacy %} {% endnote %} @@ -95,10 +95,10 @@ For tickets you submit, support is available 24 hours a day, 7 days per week. Th During the initial response time for Urgent priority tickets, you can expect us to do the following: -- The paged Support Engineer or CRE assigns and carefully reviews your ticket. The goal is to understand the issue, start troubleshooting, and identify next steps. -- In the initial response, the assigned Support Engineer or CRE will acknowledge ticket receipt and assignment as well as provide next steps to clarify and troubleshoot the situation. To assist with resolving your issue, the Support Engineer or CRE may ask for additional information such as screenshots, error messages, log files, diagnostics files, support bundles, or the output of specific console commands. -- Depending on the issue, the assigned Support Engineer or CRE may collaborate with others in Support, Engineering, or the regional incident commander. -- If a callback was requested upon opening the Urgent ticket, the assigned Support Engineer or CRE will determine if, at the current time, screen sharing is the most efficient way of driving the ticket towards resolution. If so, they will extend an offer to you to join a screen sharing session. +* The paged Support Engineer or CRE assigns and carefully reviews your ticket. The goal is to understand the issue, start troubleshooting, and identify next steps. +* In the initial response, the assigned Support Engineer or CRE will acknowledge ticket receipt and assignment as well as provide next steps to clarify and troubleshoot the situation. To assist with resolving your issue, the Support Engineer or CRE may ask for additional information such as screenshots, error messages, log files, diagnostics files, support bundles, or the output of specific console commands. +* Depending on the issue, the assigned Support Engineer or CRE may collaborate with others in Support, Engineering, or the regional incident commander. +* If a callback was requested upon opening the Urgent ticket, the assigned Support Engineer or CRE will determine if, at the current time, screen sharing is the most efficient way of driving the ticket towards resolution. If so, they will extend an offer to you to join a screen sharing session. {% data reusables.enterprise_enterprise_support.installing-releases %} @@ -125,17 +125,17 @@ If you don't receive an initial response within the guaranteed response time to The credit request must be made within 30 days of the end of the quarter during which {% data variables.contact.premium_support %} did not respond to your tickets within the designated response time. Credit requests will not be honored if the respective deadline has passed. Once the respective deadline passes, you have waived the ability to claim a refund for the qualified credit. Credit requests may take the form of a refund or credit to your account, cannot be exchanged into a cash amount, require you to have paid any outstanding invoices, and expire upon termination of your agreement with {% data variables.product.company_short %}. To receive a refund, you must submit a completed credit request to . To be eligible, the credit request must: -- Be sent from an email address associated with your account on {% data variables.location.product_location %} -- Be received by {% data variables.product.company_short %} by the end of the 30th day after the quarter in which the four qualifying credits occurred -- Include "Credit Request" in the subject line +* Be sent from an email address associated with your account on {% data variables.location.product_location %} +* Be received by {% data variables.product.company_short %} by the end of the 30th day after the quarter in which the four qualifying credits occurred +* Include "Credit Request" in the subject line The following information **must be included** in your credit request: -- **Date** (The date must be within 30 days after the quarter based on {% data variables.product.company_short %}’s fiscal year end in which the claims occurred [January 31, April 30, July 31, or October 31].) -- **Customer contact** (You must specify both name and email address.) -- **Customer address** -- **Qualifying credits** (You must provide the date of each qualifying credit and the associated ticket number.){% ifversion fpt or ghec %} -- **Name of {% data variables.product.prodname_ghe_cloud %} organization**{% endif %} -- **Ticket numbers** +* **Date** (The date must be within 30 days after the quarter based on {% data variables.product.company_short %}’s fiscal year end in which the claims occurred [January 31, April 30, July 31, or October 31].) +* **Customer contact** (You must specify both name and email address.) +* **Customer address** +* **Qualifying credits** (You must provide the date of each qualifying credit and the associated ticket number.){% ifversion fpt or ghec %} +* **Name of {% data variables.product.prodname_ghe_cloud %} organization**{% endif %} +* **Ticket numbers** ## Accessing premium content diff --git a/content/support/learning-about-github-support/about-github-support.md b/content/support/learning-about-github-support/about-github-support.md index 3716947b90ef..a27b40d52787 100644 --- a/content/support/learning-about-github-support/about-github-support.md +++ b/content/support/learning-about-github-support/about-github-support.md @@ -41,9 +41,9 @@ The support options available to {% data variables.product.prodname_dotcom %} us {% ifversion ghes %} You can contact {% data variables.contact.enterprise_support %} through the {% data variables.contact.contact_enterprise_portal %} for help with: -- Installing and using {% data variables.product.product_name %} -- Identifying and verifying the causes of suspected errors -- Installing and using {% data variables.product.prodname_advanced_security %} +* Installing and using {% data variables.product.product_name %} +* Identifying and verifying the causes of suspected errors +* Installing and using {% data variables.product.prodname_advanced_security %} {% endif %} @@ -189,7 +189,7 @@ For urgent issues, we can help you in English 24 hours per day, 7 days per week, ## Further reading {%- ifversion ghes %} -- Section 10 on Support in the "[{% data variables.product.prodname_ghe_server %} License Agreement](https://enterprise.github.com/license)" +* Section 10 on Support in the "[{% data variables.product.prodname_ghe_server %} License Agreement](https://enterprise.github.com/license)" {%- endif %} -- "[AUTOTITLE](/support/contacting-github-support/creating-a-support-ticket)" -- "[AUTOTITLE](/support/contacting-github-support/viewing-and-updating-support-tickets)" +* "[AUTOTITLE](/support/contacting-github-support/creating-a-support-ticket)" +* "[AUTOTITLE](/support/contacting-github-support/viewing-and-updating-support-tickets)" diff --git a/content/support/learning-about-github-support/about-ticket-priority.md b/content/support/learning-about-github-support/about-ticket-priority.md index 7940c30bcf63..473ffd474097 100644 --- a/content/support/learning-about-github-support/about-ticket-priority.md +++ b/content/support/learning-about-github-support/about-ticket-priority.md @@ -13,10 +13,10 @@ topics: When you contact {% data variables.contact.github_support %}, {% data variables.product.company_short %} will choose a priority for the ticket: -- {% data variables.product.support_ticket_priority_low %} -- {% data variables.product.support_ticket_priority_normal %} -- {% data variables.product.support_ticket_priority_high %} -- {% data variables.product.support_ticket_priority_urgent %} {% ifversion ghec %}([{% data variables.contact.premium_support %}](/support/learning-about-github-support/about-github-premium-support) only){% endif %} +* {% data variables.product.support_ticket_priority_low %} +* {% data variables.product.support_ticket_priority_normal %} +* {% data variables.product.support_ticket_priority_high %} +* {% data variables.product.support_ticket_priority_urgent %} {% ifversion ghec %}([{% data variables.contact.premium_support %}](/support/learning-about-github-support/about-github-premium-support) only){% endif %} {% data reusables.support.zendesk-old-tickets %} @@ -69,4 +69,4 @@ If you are uncertain if the issue is out of scope, contact {% data variables.con ## Further reading -- "[AUTOTITLE](/support/contacting-github-support/creating-a-support-ticket)" +* "[AUTOTITLE](/support/contacting-github-support/creating-a-support-ticket)" diff --git a/content/support/learning-about-github-support/github-marketplace-support.md b/content/support/learning-about-github-support/github-marketplace-support.md index 45332fd02f0c..968998d14378 100644 --- a/content/support/learning-about-github-support/github-marketplace-support.md +++ b/content/support/learning-about-github-support/github-marketplace-support.md @@ -23,5 +23,5 @@ Every app in {% data variables.product.prodname_marketplace %} includes a link t ## Further reading -- "[AUTOTITLE](/apps/using-github-apps)" -- "[AUTOTITLE](/billing/managing-billing-for-github-marketplace-apps)" +* "[AUTOTITLE](/apps/using-github-apps)" +* "[AUTOTITLE](/billing/managing-billing-for-github-marketplace-apps)" diff --git a/content/support/sharing-feedback-with-github.md b/content/support/sharing-feedback-with-github.md index cea031918f61..a2c63a1d07cb 100644 --- a/content/support/sharing-feedback-with-github.md +++ b/content/support/sharing-feedback-with-github.md @@ -33,7 +33,7 @@ Before creating a new feedback discussion, you should search for any existing di 1. After locating the correct discussion category, type some search terms in the search bar and press Return. - - For example, if you have feedback about how contributions are displayed on your profile, you could search for "Contributions" in the "Profile" category. + * For example, if you have feedback about how contributions are displayed on your profile, you could search for "Contributions" in the "Profile" category. 1. Browse the search results and if you find an existing discussion that is similar to your feedback, click the title of the discussion. 1. To add your voice and give more visibility to the discussion, click the upvote arrow at the bottom of the discussion post. @@ -51,9 +51,9 @@ If there isn't an existing feedback discussion that you can upvote, you can crea 1. Under "Select Topic Area", select **Product Feedback**. 1. Under "Body", type your feedback for the {% data variables.product.company_short %} Product team. - - Include as much information as possible to help the team understand your feedback. - - If your feedback is related to a specific scenario or workflow, include information about what you were trying to do. - - You can also include screenshots to demonstrate what your feedback is about. + * Include as much information as possible to help the team understand your feedback. + * If your feedback is related to a specific scenario or workflow, include information about what you were trying to do. + * You can also include screenshots to demonstrate what your feedback is about. 1. To confirm that you've looked for existing feedback that you could have upvoted, select **I have done a search for similar discussions**. 1. Click **Start discussion**. diff --git a/content/webhooks/about-webhooks.md b/content/webhooks/about-webhooks.md index 6bfd9b4221b5..3b96b4b3c6cb 100644 --- a/content/webhooks/about-webhooks.md +++ b/content/webhooks/about-webhooks.md @@ -30,11 +30,11 @@ Webhooks let you subscribe to events happening in a software system and automati Webhooks are used to receive data as it happens, as opposed to polling an API (calling an API intermittently) to see if data is available. With webhooks, you only need to express interest in an event once, when you create the webhook. Webhooks are used in a wide range of scenarios, including: -- Triggering CI (continuous integration) pipelines on an external CI server. For example, to trigger CI in Jenkins or CircleCI when code is pushed to a branch. -- Sending notifications about events on {% data variables.product.company_short %} to collaboration platforms. For example, sending a notification to Discord or Slack when there's a review on a pull request. -- Updating an external issue tracker like Jira. -- Deploying to a production server. -- Logging events as they happen on {% data variables.product.company_short %}, for audit purposes. +* Triggering CI (continuous integration) pipelines on an external CI server. For example, to trigger CI in Jenkins or CircleCI when code is pushed to a branch. +* Sending notifications about events on {% data variables.product.company_short %} to collaboration platforms. For example, sending a notification to Discord or Slack when there's a review on a pull request. +* Updating an external issue tracker like Jira. +* Deploying to a production server. +* Logging events as they happen on {% data variables.product.company_short %}, for audit purposes. ## About webhooks on {% data variables.product.prodname_dotcom %} @@ -51,9 +51,9 @@ For more information about creating webhooks, see "[AUTOTITLE](/webhooks/using-w ## Choosing webhooks or the REST API Using webhooks has the following advantages over using the API: -- Webhooks require less effort and less resources than polling an API. -- Webhooks scale better than API calls. If you need to monitor many resources, calling the API for each resource may cause you to hit your API rate limit quota quickly. Instead, you can subscribe to multiple webhook events and receive information only when an event happens. -- Webhooks allow near real-time updates, since webhooks are triggered when an event happens. +* Webhooks require less effort and less resources than polling an API. +* Webhooks scale better than API calls. If you need to monitor many resources, calling the API for each resource may cause you to hit your API rate limit quota quickly. Instead, you can subscribe to multiple webhook events and receive information only when an event happens. +* Webhooks allow near real-time updates, since webhooks are triggered when an event happens. If you only need information once or intermittently, or only want to get information from a small set of resources with no plans to scale up, you can call the API when you need the relevant information. @@ -67,4 +67,4 @@ For information on best practices to follow when using webhooks, see "[AUTOTITLE ## Further reading -- "[AUTOTITLE](/webhooks/types-of-webhooks)" +* "[AUTOTITLE](/webhooks/types-of-webhooks)" diff --git a/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md b/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md index 0a9734c8a2cc..1556df6d3b30 100644 --- a/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md +++ b/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md @@ -68,8 +68,8 @@ In order to respond in a timely manner, you may want to set up a queue to proces This error indicates that there is a problem related to your server's certificates. The most common problems are: -- Your server is using a self-signed certificate. -- Your server is not sending the full certificate chain when the connection is established. +* Your server is using a self-signed certificate. +* Your server is not sending the full certificate chain when the connection is established. To help diagnose the problem, you can use the [SSL server test](https://www.ssllabs.com/ssltest/analyze.html) from SSL Labs. This service can only work with the default port for HTTPS (port 443) and can only work with servers that are accessible from the Internet. diff --git a/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md b/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md index 0080e72edeb5..8a5c8e100dc4 100644 --- a/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md +++ b/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md @@ -16,9 +16,9 @@ You can view details about webhook deliveries that occurred in the past {% data For each webhook delivery, you can view: -- the request headers and payload that {% data variables.product.company_short %} sent -- the time at which the request was sent -- the response that {% data variables.product.company_short %} received from your server +* the request headers and payload that {% data variables.product.company_short %} sent +* the time at which the request was sent +* the response that {% data variables.product.company_short %} received from your server You can also redeliver recent webhook deliveries. For more information, see "[AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/redelivering-webhooks)." diff --git a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md index 7bdc61cbb14f..f4fdaa027738 100644 --- a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md +++ b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md @@ -19,9 +19,9 @@ This article describes how to write a script to find and redeliver failed delive This example shows you: -- A script that will find and redeliver failed deliveries for a {% data variables.product.prodname_github_app %} webhook -- What credentials your script will need, and how to store the credentials securely as {% data variables.product.prodname_actions %} secrets -- A {% data variables.product.prodname_actions %} workflow that can securely access your credentials and run the script periodically +* A script that will find and redeliver failed deliveries for a {% data variables.product.prodname_github_app %} webhook +* What credentials your script will need, and how to store the credentials securely as {% data variables.product.prodname_actions %} secrets +* A {% data variables.product.prodname_actions %} workflow that can securely access your credentials and run the script periodically This example uses {% data variables.product.prodname_actions %}, but you can also run this script on your server that handles webhook deliveries. For more information, see "[Alternative methods](#alternative-methods)." @@ -37,10 +37,10 @@ The endpoints to fetch and update the value of environment variables require a { 1. Store the private key, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`, from the previous step as a {% data variables.product.prodname_actions %} secret in the repository where you want the workflow to run. {% ifversion pat-v2 %} 1. Create a {% data variables.product.pat_generic %} with the following access. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)." - - For a {% data variables.product.pat_v2 %}, grant the token: - - Write access to the repository variables permission - - Access to the repository where this workflow will run - - For a {% data variables.product.pat_v1 %}, grant the token the `repo` scope. + * For a {% data variables.product.pat_v2 %}, grant the token: + * Write access to the repository variables permission + * Access to the repository where this workflow will run + * For a {% data variables.product.pat_v1 %}, grant the token the `repo` scope. {% else %} 1. Create a {% data variables.product.pat_v1 %} with the `repo` scope. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)." {% endif %} @@ -339,6 +339,6 @@ You can manually trigger your workflow to test the script. For more information, This example used {% data variables.product.prodname_actions %} to securely store credentials and to run the script on a schedule. However, if you prefer to run this script on your server than handles webhook deliveries, you can: -- Store the credentials in another secure manner, such as a secret manager like [Azure key vault](https://azure.microsoft.com/products/key-vault). You will also need to update the script to access the credentials from their new location. -- Run the script on a schedule on your server, for example by using a cron job or task scheduler. -- Update the script to store the last run time somewhere that your server can access and update. If you choose not to store the last run time as a {% data variables.product.prodname_actions %} secret, you do not need to use a {% data variables.product.pat_generic %}, and you can remove the API calls to access and update the configuration variable. +* Store the credentials in another secure manner, such as a secret manager like [Azure key vault](https://azure.microsoft.com/products/key-vault). You will also need to update the script to access the credentials from their new location. +* Run the script on a schedule on your server, for example by using a cron job or task scheduler. +* Update the script to store the last run time somewhere that your server can access and update. If you choose not to store the last run time as a {% data variables.product.prodname_actions %} secret, you do not need to use a {% data variables.product.pat_generic %}, and you can remove the API calls to access and update the configuration variable. diff --git a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md index 7163b1b20052..a07ccb190ef3 100644 --- a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md +++ b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md @@ -19,9 +19,9 @@ This article describes how to write a script to find and redeliver failed delive This example shows you: -- A script that will find and redeliver failed deliveries for a repository webhook -- What credentials your script will need, and how to store the credentials securely as {% data variables.product.prodname_actions %} secrets -- A {% data variables.product.prodname_actions %} workflow that can securely access your credentials and run the script periodically +* A script that will find and redeliver failed deliveries for a repository webhook +* What credentials your script will need, and how to store the credentials securely as {% data variables.product.prodname_actions %} secrets +* A {% data variables.product.prodname_actions %} workflow that can securely access your credentials and run the script periodically This example uses {% data variables.product.prodname_actions %}, but you can also run this script on your server that handles webhook deliveries. For more information, see "[Alternative methods](#alternative-methods)." @@ -31,12 +31,12 @@ The built in `GITHUB_TOKEN` does not have sufficient permissions to redeliver we {% ifversion pat-v2 %} 1. Create a {% data variables.product.pat_generic %} with the following access. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)." - - For a {% data variables.product.pat_v2 %}, grant the token: - - Access to the repository where your webhook was created - - Access to the repository where this workflow will run - - Write access to the repository webhooks permission - - Write access to the repository variables permission - - For a {% data variables.product.pat_v1 %}, grant the token the `repo` scope. + * For a {% data variables.product.pat_v2 %}, grant the token: + * Access to the repository where your webhook was created + * Access to the repository where this workflow will run + * Write access to the repository webhooks permission + * Write access to the repository variables permission + * For a {% data variables.product.pat_v1 %}, grant the token the `repo` scope. {% else %} 1. Create a {% data variables.product.pat_v1 %} with the `repo` scope. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)." {% endif %} @@ -357,6 +357,6 @@ You can manually trigger your workflow to test the script. For more information, This example used {% data variables.product.prodname_actions %} to securely store credentials and to run the script on a schedule. However, if you prefer to run this script on your server that handles webhook deliveries, you can: -- Store the credentials in another secure manner, such as a secret manager like [Azure key vault](https://azure.microsoft.com/products/key-vault). You will also need to update the script to access the credentials from their new location. -- Run the script on a schedule on your server, for example by using a cron job or task scheduler. -- Update the script to store the last run time somewhere that your server can access and update. If you choose not to store the last run time as a {% data variables.product.prodname_actions %} secret, you can remove the API calls to access and update the configuration variable. +* Store the credentials in another secure manner, such as a secret manager like [Azure key vault](https://azure.microsoft.com/products/key-vault). You will also need to update the script to access the credentials from their new location. +* Run the script on a schedule on your server, for example by using a cron job or task scheduler. +* Update the script to store the last run time somewhere that your server can access and update. If you choose not to store the last run time as a {% data variables.product.prodname_actions %} secret, you can remove the API calls to access and update the configuration variable. diff --git a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md index b34a3a78b041..e95451c465ef 100644 --- a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md +++ b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md @@ -19,9 +19,9 @@ This article describes how to write a script to find and redeliver failed delive This example shows you: -- A script that will find and redeliver failed deliveries for an organization webhook -- What credentials your script will need, and how to store the credentials securely as {% data variables.product.prodname_actions %} secrets -- A {% data variables.product.prodname_actions %} workflow that can securely access your credentials and run the script periodically +* A script that will find and redeliver failed deliveries for an organization webhook +* What credentials your script will need, and how to store the credentials securely as {% data variables.product.prodname_actions %} secrets +* A {% data variables.product.prodname_actions %} workflow that can securely access your credentials and run the script periodically This example uses {% data variables.product.prodname_actions %}, but you can also run this script on your server that handles webhook deliveries. For more information, see "[Alternative methods](#alternative-methods)." @@ -31,12 +31,12 @@ The built in `GITHUB_TOKEN` does not have sufficient permissions to redeliver we {% ifversion pat-v2 %} 1. Create a {% data variables.product.pat_generic %} with the following access. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)." - - For a {% data variables.product.pat_v2 %}: - - Set resource owner to be the organization where your webhook was created - - Grant the token access to the repository where this workflow will run - - Grant the token write access to the organization webhooks permission - - Grant the token write access to the repository variables permission - - For a {% data variables.product.pat_v1 %}, grant the token the `admin:org_hook` and `repo` scope. + * For a {% data variables.product.pat_v2 %}: + * Set resource owner to be the organization where your webhook was created + * Grant the token access to the repository where this workflow will run + * Grant the token write access to the organization webhooks permission + * Grant the token write access to the repository variables permission + * For a {% data variables.product.pat_v1 %}, grant the token the `admin:org_hook` and `repo` scope. {% else %} 1. Create a {% data variables.product.pat_v1 %} with the `admin:org_hook` and `repo` scope. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)." {% endif %} @@ -348,6 +348,6 @@ You can manually trigger your workflow to test the script. For more information, This example used {% data variables.product.prodname_actions %} to securely store credentials and to run the script on a schedule. However, if you prefer to run this script on your server than handles webhook deliveries, you can: -- Store the credentials in another secure manner, such as a secret manager like [Azure key vault](https://azure.microsoft.com/products/key-vault). You will also need to update the script to access the credentials from their new location. -- Run the script on a schedule on your server, for example by using a cron job or task scheduler. -- Update the script to store the last run time somewhere that your server can access and update. If you choose not to store the last run time as a {% data variables.product.prodname_actions %} secret, you can remove the API calls to access and update the configuration variable. +* Store the credentials in another secure manner, such as a secret manager like [Azure key vault](https://azure.microsoft.com/products/key-vault). You will also need to update the script to access the credentials from their new location. +* Run the script on a schedule on your server, for example by using a cron job or task scheduler. +* Update the script to store the last run time somewhere that your server can access and update. If you choose not to store the last run time as a {% data variables.product.prodname_actions %} secret, you can remove the API calls to access and update the configuration variable. diff --git a/content/webhooks/using-webhooks/best-practices-for-using-webhooks.md b/content/webhooks/using-webhooks/best-practices-for-using-webhooks.md index 94a53a129994..ea6fe9d04e9b 100644 --- a/content/webhooks/using-webhooks/best-practices-for-using-webhooks.md +++ b/content/webhooks/using-webhooks/best-practices-for-using-webhooks.md @@ -62,5 +62,5 @@ In a replay attack, a bad actor intercepts a webhook delivery and re-sends the d ## Further reading -- "[AUTOTITLE](/rest/guides/best-practices-for-integrators)" -- "[AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app)" +* "[AUTOTITLE](/rest/guides/best-practices-for-integrators)" +* "[AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app)" diff --git a/content/webhooks/using-webhooks/creating-webhooks.md b/content/webhooks/using-webhooks/creating-webhooks.md index 287bca5a68c7..7df1d24ca344 100644 --- a/content/webhooks/using-webhooks/creating-webhooks.md +++ b/content/webhooks/using-webhooks/creating-webhooks.md @@ -157,5 +157,5 @@ You can also use the REST API to create a webhook for a {% data variables.produc ## Further reading -- "[AUTOTITLE](/webhooks/about-webhooks)" -- "[AUTOTITLE](/webhooks/using-webhooks/handling-webhook-deliveries)" +* "[AUTOTITLE](/webhooks/about-webhooks)" +* "[AUTOTITLE](/webhooks/using-webhooks/handling-webhook-deliveries)" diff --git a/content/webhooks/using-webhooks/delivering-webhooks-to-private-systems.md b/content/webhooks/using-webhooks/delivering-webhooks-to-private-systems.md index 086d81d02b0e..0e53daeac74c 100644 --- a/content/webhooks/using-webhooks/delivering-webhooks-to-private-systems.md +++ b/content/webhooks/using-webhooks/delivering-webhooks-to-private-systems.md @@ -14,11 +14,11 @@ You may want to deliver {% data variables.product.company_short %} webhooks to p A reverse proxy is a web server that sits between a client and an application. The reverse proxy receives requests from the client and forwards them to the application. This ensures no direct communication occurs between clients on the internet and the underlying application. A variety of systems can serve a reverse proxy, including: -- web servers, like [nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) -- API gateways -- free, open-source overlay networks, like [OpenZiti](https://openziti.io) -- commercial ingress management tools, like [ngrok](https://ngrok.com/partners/github) -- free, open-source ingress management tools, like [zrok](https://zrok.io) +* web servers, like [nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) +* API gateways +* free, open-source overlay networks, like [OpenZiti](https://openziti.io) +* commercial ingress management tools, like [ngrok](https://ngrok.com/partners/github) +* free, open-source ingress management tools, like [zrok](https://zrok.io) How you configure your reverse proxy varies based on the system you're using. diff --git a/content/webhooks/using-webhooks/handling-failed-webhook-deliveries.md b/content/webhooks/using-webhooks/handling-failed-webhook-deliveries.md index 7d664759dfe7..28e55ddf60b7 100644 --- a/content/webhooks/using-webhooks/handling-failed-webhook-deliveries.md +++ b/content/webhooks/using-webhooks/handling-failed-webhook-deliveries.md @@ -32,8 +32,8 @@ You can also write a script that checks for failed deliveries and attempts to re For example scripts, see: -- "[AUTOTITLE](/webhooks/using-webhooks/creating-a-script-to-automatically-redeliver-failed-deliveries-for-a-repository-webhook)" -- "[AUTOTITLE](/webhooks/using-webhooks/creating-a-script-to-automatically-redeliver-failed-deliveries-for-an-organization-webhook)" -- "[AUTOTITLE](/webhooks/using-webhooks/creating-a-script-to-automatically-redeliver-failed-deliveries-for-a-github-app-webhook)" +* "[AUTOTITLE](/webhooks/using-webhooks/creating-a-script-to-automatically-redeliver-failed-deliveries-for-a-repository-webhook)" +* "[AUTOTITLE](/webhooks/using-webhooks/creating-a-script-to-automatically-redeliver-failed-deliveries-for-an-organization-webhook)" +* "[AUTOTITLE](/webhooks/using-webhooks/creating-a-script-to-automatically-redeliver-failed-deliveries-for-a-github-app-webhook)" If a webhook delivery fails repeatedly, you should investigate the cause. Each failed delivery will give a reason for failure. For more information, see "[AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks)." diff --git a/content/webhooks/using-webhooks/handling-webhook-deliveries.md b/content/webhooks/using-webhooks/handling-webhook-deliveries.md index bcc92fd8bbd0..18f3f3349425 100644 --- a/content/webhooks/using-webhooks/handling-webhook-deliveries.md +++ b/content/webhooks/using-webhooks/handling-webhook-deliveries.md @@ -64,23 +64,23 @@ In order to test your webhook locally, you can use a webhook proxy URL to forwar 1. Create a webhook with the following settings. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/creating-webhooks)." - - For the URL, use your webhook proxy URL from earlier. - - If you have an option to choose the content type, use JSON. + * For the URL, use your webhook proxy URL from earlier. + * If you have an option to choose the content type, use JSON. ## Write code to handle webhook deliveries In order to handle webhook deliveries, you need to write code that will: -- Initialize your server to listen for requests to your webhook URL -- Read the HTTP headers and body from the request -- Take the desired action in response to the request +* Initialize your server to listen for requests to your webhook URL +* Read the HTTP headers and body from the request +* Take the desired action in response to the request You can use any programming language that you can run on your server. The following examples print a message when a webhook delivery is received. However, you can modify the code to take another action, such as making a request to the {% data variables.product.company_short %} API or sending a Slack message. -- [Ruby example](#ruby-example) -- [JavaScript example](#javascript-example) +* [Ruby example](#ruby-example) +* [JavaScript example](#javascript-example) ### Ruby example @@ -282,14 +282,14 @@ Now that you have tested out your code locally, you can make changes to use your If you don't see the expected results described in the testing steps, try the following: -- Make sure that your webhook is using your webhook proxy URL (Smee.io URL). For more information about your webhook proxy URL, see "[Get a webhook proxy URL](#get-a-webhook-proxy-url)." For more information about your webhook settings, see "[AUTOTITLE](/webhooks/using-webhooks/creating-webhooks)." -- Make sure that your webhook uses the JSON content type, if you have a choice about what content type to use. For more information about your webhook settings, see "[AUTOTITLE](/webhooks/using-webhooks/creating-webhooks)." -- Make sure that both the smee client and your local server are running. You will have these processes running in two separate terminal windows. -- Make sure that your server is listening to the same port where smee.io is forwarding webhooks. All of the examples in this article use port 3000. -- Make sure that the path where smee.io is forwarding webhooks matches a route that is defined in your code. All of the examples in this article use the `/webhooks` path. -- Check for error messages in the terminal windows where you are running the smee client and your local server. -- Check {% data variables.product.company_short %} to verify that a webhook delivery was triggered. For more information, see "[AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries)." -- Check your webhook proxy URL on smee.io. You should see an event that corresponds to the event that you triggered or redelivered. This indicates that {% data variables.product.company_short %} successfully sent a webhook delivery to the payload URL that you specified. +* Make sure that your webhook is using your webhook proxy URL (Smee.io URL). For more information about your webhook proxy URL, see "[Get a webhook proxy URL](#get-a-webhook-proxy-url)." For more information about your webhook settings, see "[AUTOTITLE](/webhooks/using-webhooks/creating-webhooks)." +* Make sure that your webhook uses the JSON content type, if you have a choice about what content type to use. For more information about your webhook settings, see "[AUTOTITLE](/webhooks/using-webhooks/creating-webhooks)." +* Make sure that both the smee client and your local server are running. You will have these processes running in two separate terminal windows. +* Make sure that your server is listening to the same port where smee.io is forwarding webhooks. All of the examples in this article use port 3000. +* Make sure that the path where smee.io is forwarding webhooks matches a route that is defined in your code. All of the examples in this article use the `/webhooks` path. +* Check for error messages in the terminal windows where you are running the smee client and your local server. +* Check {% data variables.product.company_short %} to verify that a webhook delivery was triggered. For more information, see "[AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries)." +* Check your webhook proxy URL on smee.io. You should see an event that corresponds to the event that you triggered or redelivered. This indicates that {% data variables.product.company_short %} successfully sent a webhook delivery to the payload URL that you specified. ## Next steps @@ -299,10 +299,10 @@ This article demonstrated how to write code to handle webhook deliveries. It als This article gave basic examples that print a message when a webhook delivery is received. You may want to modify the code to take some other action. For example, you could modify the code to: -- Make a request to the {% data variables.product.company_short %} API -- Send a message on Slack -- Log events -- Update an external project management tool +* Make a request to the {% data variables.product.company_short %} API +* Send a message on Slack +* Log events +* Update an external project management tool ### Verify that the delivery is from {% data variables.product.company_short %} @@ -326,5 +326,5 @@ You should aim to follow best practices with your webhooks. For more information ## Further reading -- "[AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events)" -- "[AUTOTITLE](/webhooks/using-webhooks/best-practices-for-using-webhooks)" +* "[AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events)" +* "[AUTOTITLE](/webhooks/using-webhooks/best-practices-for-using-webhooks)" diff --git a/content/webhooks/using-webhooks/validating-webhook-deliveries.md b/content/webhooks/using-webhooks/validating-webhook-deliveries.md index fb88beeb52d2..48feefb8c7b8 100644 --- a/content/webhooks/using-webhooks/validating-webhook-deliveries.md +++ b/content/webhooks/using-webhooks/validating-webhook-deliveries.md @@ -32,8 +32,8 @@ To do this, you need to: You can create a new webhook with a secret token, or you can add a secret token to an existing webhook. When creating a secret token, you should choose a random string of text with high entropy. -- _To create a new webhook with a secret token_, see "[AUTOTITLE](/webhooks/using-webhooks/creating-webhooks)." -- _To add a secret token to an existing webhook_, edit the webhook's settings. Under "Secret", type a string to use as a `secret` key. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/editing-webhooks)." +* _To create a new webhook with a secret token_, see "[AUTOTITLE](/webhooks/using-webhooks/creating-webhooks)." +* _To add a secret token to an existing webhook_, edit the webhook's settings. Under "Secret", type a string to use as a `secret` key. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/editing-webhooks)." ## Securely storing the secret token @@ -47,23 +47,23 @@ In your code that handles webhook deliveries, you should calculate a hash using There are a few important things to keep in mind when validating webhook payloads: -- {% data variables.product.product_name %} uses an HMAC hex digest to compute the hash. -- The hash signature always starts with `sha256=`. -- The hash signature is generated using your webhook's secret token and the payload contents. -- If your language and server implementation specifies a character encoding, ensure that you handle the payload as UTF-8. Webhook payloads can contain unicode characters. -- Never use a plain `==` operator. Instead consider using a method like [`secure_compare`](https://www.rubydoc.info/gems/rack/Rack%2FUtils:secure_compare) or [`crypto.timingSafeEqual`](https://nodejs.org/api/crypto.html#cryptotimingsafeequala-b), which performs a "constant time" string comparison to help mitigate certain timing attacks against regular equality operators, or regular loops in JIT-optimized languages. +* {% data variables.product.product_name %} uses an HMAC hex digest to compute the hash. +* The hash signature always starts with `sha256=`. +* The hash signature is generated using your webhook's secret token and the payload contents. +* If your language and server implementation specifies a character encoding, ensure that you handle the payload as UTF-8. Webhook payloads can contain unicode characters. +* Never use a plain `==` operator. Instead consider using a method like [`secure_compare`](https://www.rubydoc.info/gems/rack/Rack%2FUtils:secure_compare) or [`crypto.timingSafeEqual`](https://nodejs.org/api/crypto.html#cryptotimingsafeequala-b), which performs a "constant time" string comparison to help mitigate certain timing attacks against regular equality operators, or regular loops in JIT-optimized languages. ### Testing the webhook payload validation You can use the following `secret` and `payload` values to verify that your implementation is correct: -- `secret`: "It's a Secret to Everybody" -- `payload`: "Hello, World!" +* `secret`: "It's a Secret to Everybody" +* `payload`: "Hello, World!" If your implementation is correct, the signatures that you generate should match the following signature values: -- signature: `757107ea0eb2509fc211221cce984b8a37570b6d7586c22c46f4379c8b043e17` -- X-Hub-Signature-256: `sha256=757107ea0eb2509fc211221cce984b8a37570b6d7586c22c46f4379c8b043e17` +* signature: `757107ea0eb2509fc211221cce984b8a37570b6d7586c22c46f4379c8b043e17` +* X-Hub-Signature-256: `sha256=757107ea0eb2509fc211221cce984b8a37570b6d7586c22c46f4379c8b043e17` ### Examples @@ -198,5 +198,5 @@ const handleWebhook = async (req, res) => { ## Further reading -- "[AUTOTITLE](/webhooks/using-webhooks/handling-webhook-deliveries)" -- "[AUTOTITLE](/webhooks/using-webhooks/best-practices-for-using-webhooks)" +* "[AUTOTITLE](/webhooks/using-webhooks/handling-webhook-deliveries)" +* "[AUTOTITLE](/webhooks/using-webhooks/best-practices-for-using-webhooks)" diff --git a/content/webhooks/webhook-events-and-payloads.md b/content/webhooks/webhook-events-and-payloads.md index 0842a4321e2c..8cb42dd9d6ff 100644 --- a/content/webhooks/webhook-events-and-payloads.md +++ b/content/webhooks/webhook-events-and-payloads.md @@ -35,16 +35,16 @@ Each event is only available to specific types of webhooks. For example, an orga HTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain several special headers: -- `X-GitHub-Hook-ID`: The unique identifier of the webhook. -- `X-GitHub-Event`: The name of the event that triggered the delivery. -- `X-GitHub-Delivery`: A globally unique identifier (GUID) to identify the event.{% ifversion ghes %} -- `X-GitHub-Enterprise-Version`: The version of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload. -- `X-GitHub-Enterprise-Host`: The hostname of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.{% endif %} -- `X-Hub-Signature`: This header is sent if the webhook is configured with a `secret`. This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the `secret` as the HMAC `key`. `X-Hub-Signature` is provided for compatibility with existing integrations. We recommend that you use the more secure `X-Hub-Signature-256` instead. -- `X-Hub-Signature-256`: This header is sent if the webhook is configured with a `secret`. This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and the `secret` as the HMAC `key`. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/securing-your-webhooks)." -- `User-Agent`: This header will always have the prefix `GitHub-Hookshot/`. -- `X-GitHub-Hook-Installation-Target-Type`: The type of resource where the webhook was created. -- `X-GitHub-Hook-Installation-Target-ID`: The unique identifier of the resource where the webhook was created. +* `X-GitHub-Hook-ID`: The unique identifier of the webhook. +* `X-GitHub-Event`: The name of the event that triggered the delivery. +* `X-GitHub-Delivery`: A globally unique identifier (GUID) to identify the event.{% ifversion ghes %} +* `X-GitHub-Enterprise-Version`: The version of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload. +* `X-GitHub-Enterprise-Host`: The hostname of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.{% endif %} +* `X-Hub-Signature`: This header is sent if the webhook is configured with a `secret`. This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the `secret` as the HMAC `key`. `X-Hub-Signature` is provided for compatibility with existing integrations. We recommend that you use the more secure `X-Hub-Signature-256` instead. +* `X-Hub-Signature-256`: This header is sent if the webhook is configured with a `secret`. This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and the `secret` as the HMAC `key`. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/securing-your-webhooks)." +* `User-Agent`: This header will always have the prefix `GitHub-Hookshot/`. +* `X-GitHub-Hook-Installation-Target-Type`: The type of resource where the webhook was created. +* `X-GitHub-Hook-Installation-Target-ID`: The unique identifier of the resource where the webhook was created. To see what each header might look like in a webhook payload, see "[Example webhook delivery](#example-webhook-delivery)."