Link Search Menu Expand Document

GitHub is where software development happens.

Files

.github repository under an organisation or user will be inherited by default for all projects created below that organisation.

  • .github/ contains GitHub-specific configuration.
    • FUNDING.yml allows specifying sponsorship preferences.
    • ISSUE_TEMPLATE.md or ISSUE_TEMPLATE/*.md provide either a single or multiple typed issue templates.
    • PULL_REQUEST_TEMPLATE.md or PULL_REQUEST_TEMPLATE/*.md applies the above to PRs.
    • workflows/ contain workflows run on GitHub Actions.
  • README.md is displayed on the project index page.
  • CODE_OF_CONDUCT.md will be linked to when new users first interact with the project via issues and PRs.
  • CONTRIBUTING.md will be linked to when new users first interact with the project via issues and PRs.
  • SECURITY.md is linked to when users first open tickets.
  • SUPPORT.md is linked to when users first open tickets.

Pull requests

In the Files tab, Hold down Alt/Option when expanding or collapsing files to apply that operation to all tabs.

Convert issue to pull request

Pull requests are simply issues with an attached branch. An existing issue can be converted to a pull request with the following API query, assuming you own the issue:

curl --request POST --header 'Authorization: token $TOKEN' --data '{"issue": $ISSUE, "head": "[$FORK:]$BRANCH", "base": "$BASE"}' https://api.github.com/repos/$ROOT/$REPO/pulls

Alternatively, with the gh CLI:

gh api repos/:owner/:repo/pulls -X POST -F issue=$ISSUE -F head=:branch -F base=$BASE

Repositories

GitHub can host package and container repositories for the following platforms:

  • Docker
  • Gradle
  • Maven
  • npm
  • Nuget
  • RubyGem

Profile READMEs

Naming a repository the same as the parent user or organisation will allow it to be rendered at the top of the profile page.