text stringlengths 12 91.7k | metadata dict |
|---|---|
About repository webhooks
Repository webhooks allow your server to receive HTTP POST payloads whenever certain events happen in a repository. For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/repos/webhooks.md",
"title": "REST API endpoints for repository webhooks"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/scim/index.md",
"title": "REST API endpoints for SCIM"
} |
About SCIM
SCIM Provisioning for Organizations
These endpoints are used by SCIM-enabled Identity Providers (IdPs) to automate provisioning of organization membership and are based on version 2.0 of the SCIM standard. IdPs should use the base URL /scim/v2/organizations/{org}/ for SCIM endpoints.
[!NOTE]
These endp... | {
"source": "github-docs/rest/scim/scim.md",
"title": "REST API endpoints for SCIM"
} |
Name Type Description
-------------------------
userNamestring The username for the user.
name.givenNamestring The first name of the user.
name.familyNamestring The last name of the user.
emails array List of user emails.
externalId string This identifier is generated by the SAML provider, and is used as a uni... | {
"source": "github-docs/rest/scim/scim.md",
"title": "REST API endpoints for SCIM"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/search/index.md",
"title": "REST API endpoints for search"
} |
About search
You can use the REST API to search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're l... | {
"source": "github-docs/rest/search/search.md",
"title": "REST API endpoints for search"
} |
See AUTOTITLE
for a complete list of available qualifiers, their format, and an example of
how to use them. For information about how to use operators to match specific
quantities, dates, or to exclude results, see AUTOTITLE.
Limitations on query length
You cannot use queries that:
Are longer than 256 characters (not... | {
"source": "github-docs/rest/search/search.md",
"title": "REST API endpoints for search"
} |
Name Description
----------------
objecturl The URL for the resource that contains a string property matching one of the search terms.
objecttype The name for the type of resource that exists at the given objecturl.
property The name of a property of the resource that exists at objecturl. That property is a string ... | {
"source": "github-docs/rest/search/search.md",
"title": "REST API endpoints for search"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/secret-scanning/alert-dismissal-requests.md",
"title": "Alert dismissal requests"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/secret-scanning/custom-patterns.md",
"title": "REST API endpoints for secret scanning custom patterns"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/secret-scanning/delegated-bypass.md",
"title": "REST API endpoints for push protection bypass requests"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/secret-scanning/index.md",
"title": "REST API endpoints for secret scanning"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/secret-scanning/push-protection.md",
"title": "REST API endpoints for secret scanning push protection"
} |
About secret scanning
You can use the API to:
Enable or disable and push protection for a repository. For more information, see AUTOTITLE and expand the "Properties of the securityandanalysis object" section.
Retrieve and update from a repository. For further details, see the sections below.
For more information ab... | {
"source": "github-docs/rest/secret-scanning/secret-scanning.md",
"title": "REST API endpoints for secret scanning"
} |
[!NOTE]
To use these endpoints, an administrator must enable for . For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/security-advisories/global-advisories.md",
"title": "REST API endpoints for global security advisories"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/security-advisories/index.md",
"title": "REST API endpoints for security advisories"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/security-advisories/repository-advisories.md",
"title": "REST API endpoints for repository security advisories"
} |
About external groups
To use these endpoints, the authenticated user must be a team maintainer or an owner of the organization associated with the team.
[!NOTE]
These endpoints are only available for organizations that are part of an enterprise using . For more information, see AUTOTITLE.
If your organization uses... | {
"source": "github-docs/rest/teams/external-groups.md",
"title": "REST API endpoints for external groups"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/teams/index.md",
"title": "REST API endpoints for teams"
} |
About team members
[!NOTE]
When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API to make changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membersh... | {
"source": "github-docs/rest/teams/members.md",
"title": "REST API endpoints for team members"
} |
About team synchronization
To use these endpoints, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see AUTOTITLE.
You can manage team ... | {
"source": "github-docs/rest/teams/team-sync.md",
"title": "REST API endpoints for team synchronization"
} |
About teams
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/teams/teams.md",
"title": "REST API endpoints for teams"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/users/attestations.md",
"title": "REST API endpoints for artifact attestations"
} |
About blocking users
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/users/blocking.md",
"title": "REST API endpoints for blocking users"
} |
About email administration
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/users/emails.md",
"title": "REST API endpoints for emails"
} |
About follower administration
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/users/followers.md",
"title": "REST API endpoints for followers"
} |
About user GPG key administration
The data returned in the publickey response field is not a GPG formatted key. When a user uploads a GPG key, it is parsed and the cryptographic public key is extracted and stored. This cryptographic key is what the endpoints in this category will return. This key is not suitable for di... | {
"source": "github-docs/rest/users/gpg-keys.md",
"title": "REST API endpoints for GPG keys"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/users/index.md",
"title": "REST API endpoints for users"
} |
About Git SSH key administration
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/users/keys.md",
"title": "REST API endpoints for Git SSH keys"
} |
About social account administration
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/users/social-accounts.md",
"title": "REST API endpoints for social accounts"
} |
About SSH signing key administration
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/users/ssh-signing-keys.md",
"title": "REST API endpoints for SSH signing keys"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/users/users.md",
"title": "REST API endpoints for users"
} |
[!NOTE]
Rate limits are only enabled for your instance if your site administrator has enabled them. Even if rate limits are disabled for your instance, you may still want to follow the best practices that are intended to help you avoid exceeding the rate limit. This can help reduce load on your servers.
Avoid polling... | {
"source": "github-docs/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md",
"title": "Best practices for using the REST API"
} |
Introduction
This article describes how to use the REST API with , curl, or JavaScript. For a quickstart guide, see AUTOTITLE.
Examples in this article send requests to . If you access at a different domain, such as , the endpoint for API requests will reflect that domain. For example: https://api.octocorp.ghe.com/.
... | {
"source": "github-docs/rest/using-the-rest-api/getting-started-with-the-rest-api.md",
"title": "Getting started with the REST API"
} |
The Events API can return different types of events triggered by activity on GitHub. Each event response contains shared properties, but has a unique payload object determined by its event type. The Event object common properties describes the properties shared by all events, and each event type describes the payload p... | {
"source": "github-docs/rest/using-the-rest-api/github-event-types.md",
"title": "GitHub event types"
} |
Issue events are triggered by activity in issues and pull requests and are available in the REST API for Issue events and Timeline events. Each event type specifies whether the event is available in the REST API for issue events or timeline events.
GitHub's REST API considers every pull request to be an issue, but not ... | {
"source": "github-docs/rest/using-the-rest-api/issue-event-types.md",
"title": "Issue event types"
} |
Pull requests
Properties for automaticbasechangefailed
automaticbasechangesucceeded
GitHub successfully attempted to automatically change the base branch of the pull request.
This event is available for the following issue types.
REST API for issue events REST API for timeline events
---------
Pull requests ... | {
"source": "github-docs/rest/using-the-rest-api/issue-event-types.md",
"title": "Issue event types"
} |
Name Type Description
-------------------------
url string The REST API URL to retrieve the issue comment.
htmlurl string The HTML URL of the issue comment.
issueurl string The HTML URL of the issue.
id integer The unique identifier of the event.
nodeid string The Global Node ID of the event.
user object ... | {
"source": "github-docs/rest/using-the-rest-api/issue-event-types.md",
"title": "Issue event types"
} |
Name Type Description
-------------------------
sha string The SHA of the commit in the pull request.
nodeid string The Global Node ID of the event.
url string The REST API URL to retrieve the commit.
htmlurl string The HTML URL of the commit.
author object The person who authored the commit.
committer obj... | {
"source": "github-docs/rest/using-the-rest-api/issue-event-types.md",
"title": "Issue event types"
} |
Name Type Description
-------------------------
actor object The person who generated the event.
createdat string The timestamp indicating when the cross-reference was added.
updatedat string The timestamp indicating when the cross-reference was updated or created, if the cross-reference is never updated.
sourc... | {
"source": "github-docs/rest/using-the-rest-api/issue-event-types.md",
"title": "Issue event types"
} |
Pull requests
Properties for disconnected
headrefdeleted
The pull request's HEAD branch was deleted.
This event is available for the following issue types.
REST API for issue events REST API for timeline events
---------
Pull requests
Properties for headrefdeleted
headrefrestored
The pull request's HEA... | {
"source": "github-docs/rest/using-the-rest-api/issue-event-types.md",
"title": "Issue event types"
} |
Pull requests
Properties for markedasduplicate
merged
The pull request was merged. The commitid attribute is the SHA1 of the HEAD commit that was merged. The commitrepository is always the same as the main repository.
This event is available for the following issue types.
REST API for issue events REST API fo... | {
"source": "github-docs/rest/using-the-rest-api/issue-event-types.md",
"title": "Issue event types"
} |
Pull requests
Properties for renamed
rename object The name details.
rename[from] string The previous name.
rename[to] string The new name.
reopened
The issue or pull request was reopened.
This event is available for the following issue types.
REST API for issue events REST API for timeline events
----... | {
"source": "github-docs/rest/using-the-rest-api/issue-event-types.md",
"title": "Issue event types"
} |
Name Type Description
-------------------------
id integer The unique identifier of the event.
nodeid string The Global Node ID of the event.
user object The person who commented on the issue.
body string The review summary text.
commitid string The SHA of the latest commit in the pull request at the time o... | {
"source": "github-docs/rest/using-the-rest-api/issue-event-types.md",
"title": "Issue event types"
} |
Pull requests
Properties for unassigned
assignee object The person unassigned from this issue.
assigner object The person who performed the unassignment for this issue. This field is available in the REST API for issue events but not the REST API for timeline events.
unlabeled
A label was removed from the iss... | {
"source": "github-docs/rest/using-the-rest-api/issue-event-types.md",
"title": "Issue event types"
} |
Pull requests
Properties for unsubscribed
userblocked
An organization owner blocked a user from the organization. This was done through one of the blocked user's comments on the issue.
This event is available for the following issue types.
REST API for issue events REST API for timeline events
---------
Issu... | {
"source": "github-docs/rest/using-the-rest-api/issue-event-types.md",
"title": "Issue event types"
} |
About libraries
You can use libraries to extend and simplify the way your application interacts with 's API. Each library provides pre-built code for a specific programming language. After integrating a library into your project, you can use the pre-built code modules to interact with 's API via a specific programming ... | {
"source": "github-docs/rest/using-the-rest-api/libraries-for-the-rest-api.md",
"title": "Libraries for the REST API"
} |
Rate limits are disabled by default for . Contact your site administrator to confirm the rate limits for your instance.
If you are a site administrator, you can set rate limits, including secondary rate limits, for your instance. See AUTOTITLE.
If you are developing an app for users or organizations outside of your ins... | {
"source": "github-docs/rest/using-the-rest-api/rate-limits-for-the-rest-api.md",
"title": "Rate limits for the REST API"
} |
Header name Description
----------------------
x-ratelimit-limit The maximum number of requests that you can make per hour
x-ratelimit-remaining The number of requests remaining in the current rate limit window
x-ratelimit-used The number of requests you have made in the current rate limit window
x-ratelimit-reset ... | {
"source": "github-docs/rest/using-the-rest-api/rate-limits-for-the-rest-api.md",
"title": "Rate limits for the REST API"
} |
Some requests that create new data, such as creating a new commit, allow you to provide timezone information when specifying or generating timestamps.
Note that these rules apply only to data passed to the API, not to data returned by the API. Timestamps returned by the API are in UTC time, ISO 8601 format.
Determinin... | {
"source": "github-docs/rest/using-the-rest-api/timezones-and-the-rest-api.md",
"title": "Timezones and the REST API"
} |
Rate limit errors
enforces rate limits to ensure that the API stays available for all users. For more information, see AUTOTITLE.
If you exceed your primary rate limit, you will receive a 403 Forbidden or 429 Too Many Requests response, and the x-ratelimit-remaining header will be 0. If you exceed a secondary rate li... | {
"source": "github-docs/rest/using-the-rest-api/troubleshooting-the-rest-api.md",
"title": "Troubleshooting the REST API"
} |
Code Description
----------------------
missing A resource does not exist.
missingfield A parameter that was required was not specified. Review the documentation for the endpoint to see what parameters are required.
invalid The formatting of a parameter is invalid. Review the endpoint documentation for more specifi... | {
"source": "github-docs/rest/using-the-rest-api/troubleshooting-the-rest-api.md",
"title": "Troubleshooting the REST API"
} |
About cross-origin requests
A cross-origin request is a request made to a different domain than the one originating the request. For security reasons, most web browsers block cross-origin requests. However, you can use cross-origin resource sharing (CORS) and JSONP callbacks to make cross-origin requests.
Cross-origin... | {
"source": "github-docs/rest/using-the-rest-api/using-cors-and-jsonp-to-make-cross-origin-requests.md",
"title": "Using CORS and JSONP to make cross-origin requests"
} |
About pagination
When a response from the REST API would include many results, will paginate the results and return a subset of the results. For example, GET /repos/octocat/Spoon-Knife/issues will only return 30 issues from the octocat/Spoon-Knife repository even though the repository includes over 1600 open issues. T... | {
"source": "github-docs/rest/using-the-rest-api/using-pagination-in-the-rest-api.md",
"title": "Using pagination in the REST API"
} |
About searching on
To search globally across all of , type what you're looking for into the search field at the top of any page, and choose "Search all of " 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... | {
"source": "github-docs/search-github/getting-started-with-searching-on-github/about-searching-on-github.md",
"title": "About searching on GitHub"
} |
You can search for designated private repositories on from . For more information about searching across environments, see AUTOTITLE.
Prerequisites
An enterprise owner for must enable and for private repositories. For more information, see AUTOTITLE.
Enabling unified repository search from
1. Sign in to both you... | {
"source": "github-docs/search-github/getting-started-with-searching-on-github/enabling-repository-search-across-environments.md",
"title": "Enabling repository search across environments"
} |
[!NOTE]
Sorting search results is not supported for code search. For more information on code search, see AUTOTITLE.
Use the Sort dropdown menu to sort results by relevance, number of stars, number of forks, and how recently the items were updated.
To sort by interactions, reactions, comments, created date, relevance... | {
"source": "github-docs/search-github/getting-started-with-searching-on-github/sorting-search-results.md",
"title": "Sorting search results"
} |
Potential timeouts
Some queries are computationally expensive for our search infrastructure to execute. To keep search fast for everyone, we limit how long any individual query can run. In rare situations when a query exceeds the time limit, search returns all matches that were found prior to the timeout and informs yo... | {
"source": "github-docs/search-github/getting-started-with-searching-on-github/troubleshooting-search-queries.md",
"title": "Troubleshooting search queries"
} |
[!NOTE]
The syntax below applies to non-code search. For more information on code search syntax, see AUTOTITLE.
Query for values greater or less than another value
You can use , =, <, and <= to search for values that are greater than, greater than or equal to, less than, and less than or equal to another value.
Query... | {
"source": "github-docs/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md",
"title": "Understanding the search syntax"
} |
Query Example
------------- -------------
<code<emYYYY</em-<emMM</em-<emDD</em</code cats created:2016-04-29 matches issues with the word "cats" that were created after April 29, 2016.
<code=<emYYYY</em-<emMM</em-<emDD</em</code cats created:=2017-04-01 matches issues with the word "cats" that were created on or a... | {
"source": "github-docs/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md",
"title": "Understanding the search syntax"
} |
Query Example
------------- -------------
<code-<emQUALIFIER</em</code cats stars:10 -language:javascript matches repositories with the word "cats" that have more than 10 stars but are not written in JavaScript.
<code-<emQUALIFIER</em</code mentions:defunkt -org:github matches issues mentioning @defunkt that are... | {
"source": "github-docs/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md",
"title": "Understanding the search syntax"
} |
About code search
code search lets you rapidly search, navigate and understand your code, your team's code, and the code of the open source community. This search engine is designed to be scalable, code-aware, and support searching code across using regular expressions, boolean operations, specialized qualifiers, an... | {
"source": "github-docs/search-github/github-code-search/about-github-code-search.md",
"title": "About GitHub Code Search"
} |
About code search query structure
The search syntax in this article only applies to searching code with code search.
Search queries consist of search terms, comprising text you want to search for, and qualifiers, which narrow down the search.
A bare term with no qualifiers will match either the content of a file or t... | {
"source": "github-docs/search-github/github-code-search/understanding-github-code-search-syntax.md",
"title": "Understanding GitHub Code Search syntax"
} |
About using code search
indexes repositories you own and repositories in organizations you are a member of, whether public, private, or internal. This means that you can search across all of your repositories, in addition to the public repositories on that have already been indexed. Only users with permission to vie... | {
"source": "github-docs/search-github/github-code-search/using-github-code-search.md",
"title": "Using GitHub Code Search"
} |
[!TIP]
By default, file finder results exclude some directories like build, log, tmp, and vendor. To search for files in these directories, use the path code search qualifieruse the filename code search qualifier. Alternatively, you can customize which directories are excluded by default using a .gitattributes file.
... | {
"source": "github-docs/search-github/searching-on-github/finding-files-on-github.md",
"title": "Finding files on GitHub"
} |
[!NOTE]
This article covers the syntax for legacy code search, which you should only need to use for the REST API endpoint for searching code.
For information on the code search syntax that you can use on , see AUTOTITLE.
For more information, see AUTOTITLE.
You can only search code using these code search qualifier... | {
"source": "github-docs/search-github/searching-on-github/searching-code.md",
"title": "Searching code {% ifversion code-search-upgrade %}(legacy){% endif %}"
} |
You can search for commits globally across all of , or search for commits within a particular repository or organization. For more information, see AUTOTITLE.
When you search for commits, only the default branch of a repository is searched.
Search within commit messages
You can find commits that contain particular wor... | {
"source": "github-docs/search-github/searching-on-github/searching-commits.md",
"title": "Searching commits"
} |
About searching for discussions
You can search for discussions globally across all of , or search for discussions within a particular organization or repository. For more information, see AUTOTITLE.
Search by the title, body, or comments
With the in qualifier you can restrict your search for discussions to the title, ... | {
"source": "github-docs/search-github/searching-on-github/searching-discussions.md",
"title": "Searching discussions"
} |
About searching for packages
You can search for packages globally across all of , or search for packages within a particular organization. For more information, see AUTOTITLE.
You can only search for packages on , not , even when is enabled.
Searching within a user's or organization's packages
To find packages owned ... | {
"source": "github-docs/search-github/searching-on-github/searching-for-packages.md",
"title": "Searching for packages"
} |
You can search for repositories globally across all of , or search for repositories within a particular organization. For more information, see AUTOTITLE.
To include forks in the search results, you will need to add fork:true or fork:only to your query. For more information, see AUTOTITLE.
Search by repository name, d... | {
"source": "github-docs/search-github/searching-on-github/searching-for-repositories.md",
"title": "Searching for repositories"
} |
Search gists
You can search for gists globally across .
Qualifier Example
:- :-
<code<emn</em</code cat stars:100 finds gists with the word "cat" that have more than 100 stars.
<codeuser:<emUSERNAME</em</code user:octocat gets all gists created by @octocat.
anon:true cat anon:true includes anonymous gists ... | {
"source": "github-docs/search-github/searching-on-github/searching-gists.md",
"title": "Searching gists"
} |
About searching
You can find apps and actions on in two ways:
Search from in .
Search across all of and then filter the results.
Searching in
1. Type any keywords and press Enter.
1. Optionally, filter your results by clicking one or more options in the left sidebar.
Searching across
Anytime you search across ... | {
"source": "github-docs/search-github/searching-on-github/searching-github-marketplace.md",
"title": "Searching GitHub Marketplace"
} |
To show forks in repository search results, add fork:true or fork:only to your query. For more information, see AUTOTITLE.
Forks are only indexed for legacy code search when they have more stars than the parent repository. You will not be able to search the code in a fork that has fewer stars than its parent. To show f... | {
"source": "github-docs/search-github/searching-on-github/searching-in-forks.md",
"title": "Searching in forks"
} |
You can search for issues and pull requests globally across all of , or search for issues and pull requests within a particular organization. For more information, see AUTOTITLE.
[!TIP]
This article contains example searches on , but you can use the same search filters on other platforms.
You can build advanced f... | {
"source": "github-docs/search-github/searching-on-github/searching-issues-and-pull-requests.md",
"title": "Searching issues and pull requests"
} |
Search for topics
You can search for topics on , explore related topics, and see how many repositories are associated with a certain topic.
1. Navigate to .
1. Type a topic keyword.
1. In the left sidebar, to narrow your search to topics, click Topics.
!Screenshot of the repository search results page for the searc... | {
"source": "github-docs/search-github/searching-on-github/searching-topics.md",
"title": "Searching topics"
} |
You can search for users globally across a platform, for example: across or across .
For more information, see AUTOTITLE.
Search only users or organizations
By default, searching users will return both personal and organizations. However, you can use the type qualifier to restrict search results to personal accounts... | {
"source": "github-docs/search-github/searching-on-github/searching-users.md",
"title": "Searching users"
} |
You can search wikis globally across all of , or search wikis within a particular repository or organization. For more information, see AUTOTITLE.
Search within a user's or organization's repositories
To find wiki pages from all repositories owned by a certain user or organization, use the user or org qualifier. To fi... | {
"source": "github-docs/search-github/searching-on-github/searching-wikis.md",
"title": "Searching wikis"
} |
Short version: We host a wide variety of collaborative projects from all over the world, and that collaboration only works when our users are able to work together in good faith. While using the Service, you must comply with our Acceptable Use Policies, which include some restrictions on content and conduct on GitHub r... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-acceptable-use-policies.md",
"title": "GitHub Acceptable Use Policies"
} |
Being part of a community includes not taking advantage of other members of the community. We do not allow anyone to use our platform in direct support of unlawful attacks that cause technical harms, such as using GitHub as a means to deliver malicious executables or as attack infrastructure, for example by organizing ... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md",
"title": "GitHub Active Malware or Exploits"
} |
Appeal and Reinstatement
While the majority of interactions between individuals in GitHub’s community fall within our Acceptable Use Policies and Community Guidelines, violations of those policies do occur at times. When they do, GitHub staff may need to take enforcement action to address the violations. However, we un... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-appeal-and-reinstatement.md",
"title": "GitHub Appeal and Reinstatement"
} |
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 activity in a way that amounts to abuse
Following another user around the platform in a ma... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-bullying-and-harassment.md",
"title": "GitHub Bullying and Harassment"
} |
GitHub does not allow any content or conduct on GitHub that exploits, harms, or endangers children, and we have a zero-tolerance policy for child sexual exploitation or abuse material (CSAM). This means you may not engage in activities including but not limited to:
Uploading, linking to, or otherwise distributing or p... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-child-sexual-exploitation-or-abuse.md",
"title": "GitHub Child Sexual Exploitation or Abuse"
} |
Being part of a community includes recognizing how your behavior affects others and engaging in meaningful and productive interactions with people and the platform they rely on.
We do not allow behavior that significantly or continually disrupts the experience of other users. This includes:
Posting off-topic comments
... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users.md",
"title": "GitHub Disrupting the Experience of Other Users"
} |
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 pe... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-doxxing-and-invasion-of-privacy.md",
"title": "GitHub Doxxing and Invasion of Privacy"
} |
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.... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-hate-speech-and-discrimination.md",
"title": "GitHub Hate Speech and Discrimination"
} |
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 deceptivel... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-impersonation.md",
"title": "GitHub Impersonation"
} |
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 so... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-misinformation-and-disinformation.md",
"title": "GitHub Misinformation and Disinformation"
} |
GitHub does not tolerate the distribution of non-consensual intimate imagery (NCII). This includes, but is not limited to:
Private or intimate images or videos shared without the consent of all individuals depicted
Threats to share intimate images or videos
Sexually suggestive images or videos of a person taken in a... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-non-consensual-intimate-imagery.md",
"title": "GitHub Non-Consensual Intimate Imagery"
} |
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 b... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-sexually-obscene-content.md",
"title": "GitHub Sexually Obscene Content"
} |
GitHub does not allow any projects that are designed for, encourage, promote, support, or suggest in any way the use of large language models or any other synthetic or manipulated media tools for the creation of:
Sexual material involving minors or any other content that would constitute Child Sexual Abuse Material un... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-synthetic-media-and-ai-tools.md",
"title": "GitHub Synthetic Media and AI Tools"
} |
GitHub does not allow any content or conduct on GitHub that furthers terrorism or violent extremism (TVE). We will remove content and may ban accounts affiliated with TVE groups or individuals. You may not use GitHub for activities including but not limited to:
Organizing, inciting, planning, coordinating, or calling ... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-terrorism-and-violent-extremism.md",
"title": "GitHub Terrorism and Violent Extremism"
} |
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, i... | {
"source": "github-docs/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content.md",
"title": "GitHub Threats of Violence and Gratuitously Violent Content"
} |
Welcome to GitHub's Guide to the Digital Millennium Copyright Act, commonly known as the "DMCA." This page is not meant as a comprehensive primer to the statute. However, if you've received a DMCA takedown notice targeting content you've posted on GitHub or if you're a rights-holder looking to issue such a notice, this... | {
"source": "github-docs/site-policy/content-removal-policies/dmca-takedown-policy.md",
"title": "DMCA Takedown Policy"
} |
We offer this private information removal process as an exceptional service only for high-risk content that violates GitHub's Terms of Service, such as when your security is at risk from exposed access credentials. This guide describes the information GitHub needs from you in order to process a request to remove privat... | {
"source": "github-docs/site-policy/content-removal-policies/github-private-information-removal-policy.md",
"title": "GitHub Private Information Removal Policy"
} |
What is a GitHub Trademark Policy Violation?
Using a company or business name, logo, or other trademark-protected materials in a manner that may mislead or confuse others with regard to its brand or business affiliation may be considered a trademark policy violation.
What is not a GitHub Trademark Policy Violation?
Us... | {
"source": "github-docs/site-policy/content-removal-policies/github-trademark-policy.md",
"title": "GitHub Trademark Policy"
} |
This guide describes the information that GitHub needs in order to process a counter notice to a DMCA takedown request. If you have more general questions about what the DMCA is or how GitHub processes DMCA takedown requests, please review our DMCA Takedown Policy.
If you believe your content on GitHub was mistakenly d... | {
"source": "github-docs/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md",
"title": "Guide to Submitting a DMCA Counter Notice"
} |
This guide describes the information that GitHub needs in order to process a DMCA takedown request. If you have more general questions about what the DMCA is or how GitHub processes DMCA takedown requests, please review our DMCA Takedown Policy.
Due to the type of content GitHub hosts (mostly software code) and the way... | {
"source": "github-docs/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md",
"title": "Guide to Submitting a DMCA Takedown Notice"
} |
We understand that copyrighted, trademarked, or private content may get published on GitHub – either accidentally or on purpose – sometimes in repositories that you do not own. Because the nature of this content varies, and because of different applicable laws, each category has its own, distinct reporting requirements... | {
"source": "github-docs/site-policy/content-removal-policies/submitting-content-removal-requests.md",
"title": "Submitting content removal requests"
} |
GitHub upholds our commitment to ethical business practices, including by prohibiting bribery and corruption. As Transparency International 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... | {
"source": "github-docs/site-policy/github-company-policies/github-anti-bribery-statement.md",
"title": "GitHub Anti-Bribery Statement"
} |
GitHub recognizes that our business is built on positive and transparent relationships. While informal interactions and exchanges of gifts may be part of developing those relationships and may even be considered customary in some countries, we need to ensure that we’re following anti-bribery laws. We have a legal oblig... | {
"source": "github-docs/site-policy/github-company-policies/github-gifts-and-entertainment-policy.md",
"title": "GitHub Gifts and Entertainment Policy"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.