The following rules are included within PSRule.Rules.GitHub
.
Name | Synopsis | Severity |
---|---|---|
GitHub.Branch.Name | Use a consistent naming convention for your branches to identify the work done in the branch. | Awareness |
Name | Synopsis | Severity |
---|---|---|
GitHub.Repo.CodeOfConduct | Use a CODE_OF_CONDUCT.md file in the default branch to set standards for community engagement. | Awareness |
GitHub.Repo.CodeOwners | Use a CODEOWNERS file in the default branch. | Important |
GitHub.Repo.Contributing | Use a CONTRIBUTING.md file in the default branch to communicate how to contribute to the project. | Important |
GitHub.Repo.Protected | Enable branch protection on the repository default branch. | Critical |
GitHub.Repo.Readme | Use a README.md file in the default branch to explain the project and provide information. | Important |