리포지토리 모범 사례

Create a README file

To make it easier for people to understand and navigate your work, we recommend that you create a README file for every repository.

You can add a README file to a repository to communicate important information about your project. A README, along with a repository license, citation file and contribution guidelines, communicates expectations for your project and helps you manage contributions. For more information, see About READMEs.

Secure your repository

You should secure your repository using GitHub's available security features to protect your code from vulnerabilities, unauthorized access, and other potential security threats. At a minimum, you should enable the following features:

• Dependabot alerts notify you of security vulnerabilities in your project's dependency network, so that you can update the affected dependency to a more secure version.
• Secret scanning scans your repository for secrets (such as API keys and tokens) and alerts you if a secret is found, so that you can remove the secret from your repository.
• Push protection prevents you (and your collaborators) from introducing secrets to the repository in the first place, by blocking pushes containing supported secrets.
• Code scanning identifies vulnerabilities and errors in your repository's code, so that you can fix these issues early and prevent a vulnerability or error being exploited by malicious actors.

Additionally, you might also consider:

• Adding a SECURITY.md file to your repository. The SECURITY.md file provides instructions to collaborators on how to report security vulnerabilities found in your project and encourages responsible disclosure.

For more information, see Quickstart for securing your repository.

Favor branching over forking

To streamline collaboration, we recommend that regular collaborators work from a single repository, creating pull requests between branches instead of between repositories. Forking is best suited for accepting contributions from people that are unaffiliated with a project, such as open-source contributors.

To maintain quality of important branches, such as main, while using a branching workflow, you can use protected branches with required status checks and pull request reviews. For more information, see About protected branches.

Use Git Large File Storage

To optimize performance, GitHub limits the sizes of files allowed in repositories. For more information, see About large files on GitHub.

To track large files in a Git repository, we recommend using Git Large File Storage (Git LFS). For more information, see About Git Large File Storage.