Как оформить github repo?

Q: Что нужно при создании repo?

A: Нужно:

• указать имя - до 4 слов(чем меньше тем лучше) в snake_case
• указать описание - одним предложением описать суть проекта
• указать лицензию - по умолчанию лучше Apache License Version 2.0

Q: Что нужно указать в настройках?

A: Нужно:

• General -> Features -> Issues -- включить
• General -> Pull Requests ->
  • Allow merge commits, Allow squash merging, Allow rebase merging - нужны для GitFlow branch merge, Feature/Bugfix branch squash/rebase
  • Always suggest updating pull request branches, Automatically delete head branches - включить
• General -> Action -> General -> Actions permissions -> Allow all actions and reusable workflows
• Action -> General -> Workflow permissions -> Read repository contents and packages permissions, Allow GitHub Actions to create and approve pull requests - включить
• Environments -- Добавить окружение как минимум для релиза артифактов(docker, maven, npm)
  • Deployment protection rules -> Required reviewers -- добавить как минимум себя
  • добавить необходимые secrets(DOCKER_HUB_USERNAME, DOCKER_HUB_PASSWORD) variables(DOCKER_IMAGE_NAME)
• Code security and analysis -> Dependabot -> Dependabot alerts, Dependabot security updates, Grouped security updates - включить
• Code security and analysis -> Dependabot -> Dependabot version updates - включить если используется Dependabot, но предпочтительнее Renovate
• Secret and variables -> Actions -- добавить общие для всех окружений и workflow secrets и variables
• GitHub Apps -- должен быть добавлен Renovate
• General -> Pull Requests -- включить все опции
• General -> Pull Requests -- включить все опции

Q: Что нужно указать в security?

A: Нужно:

• Overview -> Security advisories, Dependabot alerts - включить

Q: question?

A: answer