------------------------------------------------------------------------------------
Background
------------------------------------------------------------------------------------
Automation of routine tasks in open source projects enhances their functionality and broadens their utility to a wider audience. But there are barriers to entry in accessing and developing continuous integration tools. These include :
- A lack of the necessary knowledge or skillset.
- A lack of understanding of what GitHub Actions can offer in open source projects.
- A GitHub marketplace aimed at general solutions or platforms.
- A lack of examples of GitHub Actions being used in Project Catalyst
------------------------------------------------------------------------------------
Proposed Solution - Automate, Educate, Communicate
------------------------------------------------------------------------------------
Automate
------------------------------------------------------------------------------------
The first part of this proposal addresses
- What to automate &
- How to incentivize development, documentation & transfer of knowledge
What to automate : we intend to focus on Actions that will automate Treasury Guild & governance projects such as Catalyst Circle Admin. This will provide a discrete context on which to build a library of Actions.
How to incentivize : Development, documentation & transfer of knowledge will be incentivized by offering an hourly fee and a structured submission process (see example here).
Each GitHub Action submitted must include :
- An Overview : providing context, a description of its function and documentation with screenshots.
- A Reference Example : providing a link to example of the GitHub Action working in production.
- The Code : A complete listing of the YAML script
- A brief Budget : Specifying hours worked on development, testing, documentation & implementation in production.
Each submission will be reviewed & signed-off (if successful) by Andre Diamond and/or Stephen Whitenstall
-----------------------------------------------------------------------------------
Educate
------------------------------------------------------------------------------------
The second part of this proposal addresses
- Production of open source training materials
This part of the proposal builds upon materials currently being prepared as part of the Fund 6 : Open Source Training project. Elements of workshops & presentations such as 'How to build a Challenge Team GitBook' and 'Circle Admin GitHub Training' will be broken down into more digestible parts.
This will include :
- Slides - to be used in future Catalyst School sessions & presentations.
- Timestamps - more descriptive timestamps of workshop recordings to guide learning.
- Transcripts & summaries - textual content produced for 'How to' guides.
- Feedback - useful comments & suggestions from past participants.
-----------------------------------------------------------------------------------
Communicate
-----------------------------------------------------------------------------------
The third & final part of this proposal addresses
- How to communicate what open source means to Cardano & Catalyst
This part of the proposal will draw on research into the Cardano open source roadmap and authoritative definitions of open source such as the Open Source Initiative. We intend to investigate what a committment to open source actually means for community partipation and communicate this through presentations & workshops.
This will include :
- Research into the Cardano open source roadmap, open source definitions & associated community projects
- Presentations & workshops on opensource themes
----------------------------------------------------------------------------------------
This proposal addresses the challenge by providing :
- Education in the form of open source training in GitHub and associated tools such as GitBook
- Incentives to develop GitHub Actions, document them and host them in open repositories as common tools
- Training events in collaboration with Catalyst School, QADAO & the Treasury Guild
- A grassroots, bottom-up approach to open source knowledge transfer
- All development & training materials will be freely available under an open source license
- A commitment to abide by The Open Source Definition - https://opensource.org/osd
––––––––––––––––––––––––––––––––––––––––––––
Proliferation of information sources
There is an emerging risk of proliferation of information sources in the Catalyst community. To mitigate this QADAO is following a strategy of aggregating sources. For example merging GitBooks where possible, migrating content to open source websites or listing content on aggregation sites.