OS-Advisory_Conseil-SO
OS-Advisory_Conseil-SO copied to clipboard
canada-ca
Optimizing OSAB on GitHub
📝 What
This issue captures annotated notes from a meeting where the purpose was:
- to start a discussion on how to optimize the Open Source Advisory Board (OSAB) presence on GitHub
- awareness of the available options on GitHub
📆 When
This meeting was originally held on 2018-10-31.
👥 Who
Attendees of this meeting included:
- @gcharest
- @StaceyWilliams
🔢 Agenda
-
[x] 🎯 Goals of OSAB on GitHub
-
[x] :octocat: The GitHub platform
-
[x] 📚 GitHub resources
-
[x] ⏭ Next Steps
:dart: Goals of OSAB on GitHub
Some of the goals of the OSAB presence on GitHub were identified as:
-
A centralized location for assessments, meeting notes, and reference materials
-
A place for publishing documentation in a presentable and easily navigable manner
-
A collaboration space that enables everyone to consume and contribute to the information
@gcharest, @StaceyWilliams, please update this with anything I may have missed or misinterpreted.
:octocat: The GitHub platform
Some of the available features of the GitHub platform can be visually summarized with this "pyramid".
The following further describes some of the feature options that help to enable collaboration, activity management, and documentation--including example patterns from other organizations on GitHub.
Collaboration
-
[x] Teams
You can group organization members into teams that reflect your company or group's structure with cascading access permissions and mentions--e.g.:
-
OSAB-members;OSAB-maintainers -
people-working-group;rules-working-group;tools-working-group
This enables the ability to @mention an entire team.
-
-
[x] Collaborators
An outside collaborator is a person who isn't explicitly a member of your organization, but who has Read, Write, or Admin permissions to one or more repositories in your organization--e.g.:
-
A person who isn't explicitly a member of https://github.com/canada-ca
-
but has permission to https://github.com/canada-ca/OS-Advisory_Conseil-SO
-
Activity Management
-
[x] Issues
An assortment of activities can be managed with issues and labels to help categorize them--e.g.:
- Facebook's React Native uses issues for many different activities and items
Issues can then be searched by label or searched by other filters--e.g.:
- All issues that are labeled as
Help Wanted
Issue templates enable you to prompt for and provide guidance on expected information--e.g.:
-
[x] Projects
You can use project boards to organize issues and pull requests and manage your workflow across a repository or organization. You can also quickly create notes that can be converted to issues--e.g.:
- Kubernetes' uses project boards to manage many different flows of work
Documentation
-
[x] READMEs
A README is often the first item a visitor will see when visiting your repository. A README file, along with a repository license, contribution guidelines, and a code of conduct, helps you communicate expectations for and manage contributions to your project--e.g.:
- The README for Docker's documentation outlines how to provide feedback and contribute
-
[x] Wikis
Whereas a README is intended to quickly orient readers as to what your project can do, wikis can be used to provide additional documentation--e.g.:
- The wiki for Microsoft's TypeScript provides additional information from a roadmap to a FAQ
-
[x] Pages
Complementing READMEs and wikis, GitHub Pages provides you with a static site hosting service designed to host your personal, organization, or project pages directly from a GitHub repository--e.g.:
- Twitter uses a GitHub page for their Open Source website
📚 GitHub resources
There are a number of resources available to help you get started with Git and GitHub, including:
Thanks @mikenwin that's a great summary!
Also lots of great and easy to understand resources listed here!
