GitHub Repository “Best Practices”

adminBest Practices0 Comments

GitHub Repository Best Practices

Create a New Repository

1. Always initialize repository with a README.md and .gitignore

2. If it's an Open Source project, initialize it with the APACHE2 license

3. Update LICENSE file (if applicable)


Copyright {yyyy} {name of copyright owner}
should be
Copyright 2018 Cloud Posse, LLC

4. Set a meaningful Description that describes the purpose repository

4. Add some useful tags to help discovery of the project

5. Submit all new work as PR.

6. Create new label wip for “Work in Progress”

Repository Settings

  • Disable “Merge Commit” and disable “Rebase Merging”
  • Enable Branch Protections

IMPORTANT: If CI enabled then require status checks to pass.

Leave a Reply

Your email address will not be published. Required fields are marked *