https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories

Naming conventions

General naming conventions

• use lowercase for filenames whenever possible. No need to SHOUT!
• always use a proper file-extension. Not README, but readme.md.
• Avoid polluting the root of your project-directory with file that are not required to be in the root.
• Only keep files in the root if there are really required there.
• .yaml is the official file-extension for YAML-files.

Naming of the Github-repository:

• dashed lowercase, e.g. foo-bar
• ascii, avoid non-ascii unicode chars
• use lowercase, avoid capitals (git clone will create a similar named local directory)
• prefer dashes over underscores

Required files to optimize Github-UI

• license.md:
  • use license-file in the root of the project, as github will introspect this file to enhance the UI.
  • github will not follow symlinks
  • lowercase + use file-extension, e.g license.md
  • the title in the license-file should contain the name of the license, e.g. MIT
  • github will render a summarized view when viewing the license-file:

• docs/code-of-conduct.md

  • use lowercase
  • github will recognize a code-of-conduct in the docs/-directory.

• docs/contributing.md

  • use lowercase
  • github will recognize a readme in the docs/-directory.

• docs/readme.md

  • use lowercase
  • github will recognize a readme in the docs/-directory.

• docs/security.md

  • github will recognize a code-of-conduct in the docs/-directory.

• .github/CODEOWNERS

  • github is not very consistent with uppercasing/lowercasing required filenames
  • CODEOWNERS must be uppercased

• .github/ISSUE_TEMPLATE

  • the directory ISSUE_TEMPLATE must be uppcased

• .github/ISSUE_TEMPLATE/bug_report.md

• .github/ISSUE_TEMPLATE/feature_request.md

• .github/dependabot.yaml

• .github/funding.yaml

• .github/pull_request_template.md

Right navigation in Github

Community Standards

Community Standards for this project:

Security Overview

Security Overview