Bitzu

GH-900 ยท Repositories

Key repository files

Purpose and location of README, LICENSE, CONTRIBUTING, CODEOWNERS and SECURITY files and how GitHub surfaces them.

Key points

  • README explains the project and is shown on the repo home page.
  • LICENSE states reuse terms.
  • CONTRIBUTING guides people who want to help.
  • SECURITY says how to report vulnerabilities.
  • CODEOWNERS maps paths to people or teams who get review requests.
  • Most live in the root, docs/ or .github/.

Source: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

Practice questions

Single choice

Which file makes GitHub automatically request pull request reviews from specific people or teams based on the files changed?

  1. README.md
  2. LICENSE
  3. CODEOWNERS
  4. CONTRIBUTING.md
Show answer

Answer: C. CODEOWNERS

CODEOWNERS maps file patterns to owners, who are then requested as reviewers. README, LICENSE and CONTRIBUTING are informational and trigger no review requests.

Select all that apply

Which of these files can be provided as defaults from an account's .github repository?

  1. CONTRIBUTING.md
  2. LICENSE
  3. SECURITY.md
  4. CODE_OF_CONDUCT.md
  5. .gitignore
Show answer

Answer: A. CONTRIBUTING.md, C. SECURITY.md, D. CODE_OF_CONDUCT.md

CONTRIBUTING.md, SECURITY.md and CODE_OF_CONDUCT.md are supported default community health files. License files cannot be defaults and must live in each repository, and .gitignore is not a community health file.

True or false

True or false: a LICENSE file placed in an organization's .github repository is automatically applied as the default license of all its repositories.

Show answer

Answer: False

False. License files cannot be defaults; each repository needs its own LICENSE file to state its terms.

Practice 8 questions on this topic in Bitzu

Short lessons, instant explanations and spaced review of what you get wrong. Free on iOS and Android.

Download on the App StoreGet it on Google Play

More GH-900 topics in this module