diff --git a/patterns/docs/Source Code Repositories/GitHub Organization Administration/GitHub Organization Administration.md b/patterns/docs/Source Code Repositories/GitHub Organization Administration/GitHub Organization Administration.md index 30cc3d8..63b983e 100644 --- a/patterns/docs/Source Code Repositories/GitHub Organization Administration/GitHub Organization Administration.md +++ b/patterns/docs/Source Code Repositories/GitHub Organization Administration/GitHub Organization Administration.md @@ -66,6 +66,8 @@ Repositories and Branching - Establish a branching strategy (e.g., Gitflow) for a structured development process. + - The authority to create BCGOV-C repos will remain with OCIO. + Issue Tracking - Utilize GitHub Issues for tracking tasks, bugs, and enhancements. diff --git a/patterns/docs/Source Code Repositories/GitHub Organization Administration/data.json b/patterns/docs/Source Code Repositories/GitHub Organization Administration/data.json index e67dc33..a22963e 100644 --- a/patterns/docs/Source Code Repositories/GitHub Organization Administration/data.json +++ b/patterns/docs/Source Code Repositories/GitHub Organization Administration/data.json @@ -1 +1 @@ -{"id":"197493858","type":"page","status":"current","title":"GitHub Organization Administration","body":{"storage":{"value":"
Status | Document |
---|---|
Stakeholders | NRIDS Architecture, FDS |
Description | The purpose of this page is to outline practices when managing GitHub Org Administration |
Outcome | Consistent point of reference for onboarding new product teams into the NRM's. |
Owner | NRIDS Architecture, FDS |
Organization Structure
- Define a clear organizational structure with teams based on projects or functions.
- Assign
Access Control
- Regularly review and update
- Implement branch protection rules to safeguard critical branches.
License Management
-
-
Repositories and Branching
-
- Establish a branching strategy (e.g., Gitflow) for a structured development process.
Issue Tracking
- Utilize
- Establish labeling conventions for better categorization.
Backups and Recovery
- Regularly back up repositories and related data.
- Establish a recovery plan in case of accidental data loss or compromise.
Code Review Process
- Implement a code review process to maintain code quality.
- Require reviews before merging, and use pull request templates.
Security Measures
- Regularly scan code for vulnerabilities using GitHub code scanning.
- Implement Dependabot for automated dependency updates.
- Set up continuous integration and continuous deployment (CI/CD) pipelines.
- Use GitHub Actions or other CI/CD tools to automate testing and deployment processes.
Documentation
- Maintain comprehensive README files for each repository.
- Utilize GitHub Wiki for extensive documentation on larger projects.
Collaboration and Communication
- Encourage collaboration through discussion in issues and pull requests.
- Use GitHub Discussions for broader conversations within the organization.
Training and Onboarding
- Provide training sessions for new members on GitHub workflows.
- Maintain a detailed onboarding guide for new contributors.
Community Guidelines
- Establish and communicate community guidelines for contributors.
- Enforce a code of conduct to ensure a positive and inclusive environment.
- Use GitHub Insights to monitor repository activity and contributions.
- Analyze metrics to identify areas for improvement in development processes.
Regular Audits
- Conduct periodic audits of repositories, permissions, and workflows.
- Address any issues or improvements identified during audits.
Ie. Script a monthly mail out to Github Team administrators to review team memberships they own.
Ie. Script compliance to metadata standards (readme/pubcode)
https://stackify.com/managing-teams-github/
GitHub in BC Government - RC1.pdf
https://developer.gov.bc.ca/docs/default/component/bc-developer-guide/use-github-in-bcgov
Status | Document |
---|---|
Stakeholders | NRIDS Architecture, FDS |
Description | The purpose of this page is to outline practices when managing GitHub Org Administration |
Outcome | Consistent point of reference for onboarding new product teams into the NRM's. |
Owner | NRIDS Architecture, FDS |
Organization Structure
- Define a clear organizational structure with teams based on projects or functions.
- Assign
Access Control
- Regularly review and update
- Implement branch protection rules to safeguard critical branches.
License Management
-
-
Repositories and Branching
-
- Establish a branching strategy (e.g., Gitflow) for a structured development process.
- The authority to create BCGOV-C repos will remain with OCIO.
Issue Tracking
- Utilize
- Establish labeling conventions for better categorization.
Backups and Recovery
- Regularly back up repositories and related data.
- Establish a recovery plan in case of accidental data loss or compromise.
Code Review Process
- Implement a code review process to maintain code quality.
- Require reviews before merging, and use pull request templates.
Security Measures
- Regularly scan code for vulnerabilities using GitHub code scanning.
- Implement Dependabot for automated dependency updates.
- Set up continuous integration and continuous deployment (CI/CD) pipelines.
- Use GitHub Actions or other CI/CD tools to automate testing and deployment processes.
Documentation
- Maintain comprehensive README files for each repository.
- Utilize GitHub Wiki for extensive documentation on larger projects.
Collaboration and Communication
- Encourage collaboration through discussion in issues and pull requests.
- Use GitHub Discussions for broader conversations within the organization.
Training and Onboarding
- Provide training sessions for new members on GitHub workflows.
- Maintain a detailed onboarding guide for new contributors.
Community Guidelines
- Establish and communicate community guidelines for contributors.
- Enforce a code of conduct to ensure a positive and inclusive environment.
- Use GitHub Insights to monitor repository activity and contributions.
- Analyze metrics to identify areas for improvement in development processes.
Regular Audits
- Conduct periodic audits of repositories, permissions, and workflows.
- Address any issues or improvements identified during audits.
Ie. Script a monthly mail out to Github Team administrators to review team memberships they own.
Ie. Script compliance to metadata standards (readme/pubcode)
https://stackify.com/managing-teams-github/
GitHub in BC Government - RC1.pdf
https://developer.gov.bc.ca/docs/default/component/bc-developer-guide/use-github-in-bcgov