- Do not store private or sensitive data in GitHub. This includes passwords, keys, personal data, private configuration data. If you think you pushed anything private to GitHub, consider it compromised and notify your manager.
- Repositories should be public unless there is a compelling reason to keep it private. Starting with a public repo and making the source code open from the beginning is much easier than starting as a closed source project are then attempting to open source it when it's "ready". If you're unsure, ask your manager.
- The Government of Canada position on Open Source is to open source code by default when possible:
- Projects that are no longer maintained should be Archived instead of deleted.
- Do not commit code directly to the main branch. The recommended practice is to create a feature branch and a pull request when your code is ready to be merged.
- Repositories should be given a useful name that describes the project. For example, terraform-module-eks-cluster is more appropriate than eks.
- Repository names should be all lowercase and use a hyphen instead of an underscore.
- Ne stockez pas de données privées ou sensibles dans GitHub. Cela inclut les mots de passe, les clés, les données personnelles, les données de configuration privées. Si vous pensez avoir poussé quelque chose de privé vers GitHub, considérez-le comme compromis et informez-en votre gestionnaire.
- Les référentiels doivent être publics, à moins qu’il n’y ait une raison impérieuse de les garder privés. Il est beaucoup plus facile de commencer avec un référentiel public et de rendre le code « source open » dès le début que de commencer par un projet « open source » qui tente ensuite de l’ouvrir lorsqu’il est « prêt ». Si vous n’êtes pas certain, demandez à votre gestionnaire.
- La position du gouvernement du Canada à l’égard de « open source » est d’ouvrir le code source par défaut lorsque cela est possible :
- Les projets qui ne sont plus maintenus doivent être archivés Archivage au lieu d’être supprimés.
- Ne pas faire un « commit » de code directement dans la branche principale. Il est recommandé de créer une branche de fonctionnalité et une demande de tirage lorsque votre code est prêt à être fusionné.
- Les référentiels doivent recevoir un nom utile qui décrit le projet. Par exemple, « terraform-module-eks-cluster » est plus approprié que « eks ».
- Les noms des référentiels doivent être tous en minuscules et utiliser un trait d’union au lieu d’un trait de soulignement « underscore ».