├── FOCUS GROUPS ├── technicalwriters-group.md ├── communitymanagers-group.md ├── developer-group.md ├── designers-group.md └── researchers-group.md ├── .github └── FUNDING.yml ├── LICENSE ├── README.md ├── CHAOSS Glossary.md ├── Hacktoberfest ├── FromZeroTo100.md ├── DocScavanger.md └── Hacktoberfest.md └── CONTRIBUTING.md /FOCUS GROUPS/technicalwriters-group.md: -------------------------------------------------------------------------------- 1 | # About 2 | This is the Chaoss Africa Technical Writers Subgroup. 3 | 4 | ## You can access the different documents below: 5 | 6 | 7 | Meeting Time: 8 | #### Chaoss Africa Technical writers Lead: 9 | -------------------------------------------------------------------------------- /FOCUS GROUPS/communitymanagers-group.md: -------------------------------------------------------------------------------- 1 | # About 2 | This is the Chaoss Africa Community Managers Subgroup. 3 | ## You can access the different documents below: 4 | Meeting Time: 5 | #### Chaoss Africa Community Managers Lead: **Ruth Ikegah** 6 | -------------------------------------------------------------------------------- /FOCUS GROUPS/developer-group.md: -------------------------------------------------------------------------------- 1 | # About 2 | This is the Chaoss Africa Developers Subgroup. 3 | ## You can access the different documents below: 4 | Ongoing projects you can contribute to are listed [here](https://docs.google.com/document/d/1B4O0Li1ZG-QvIAG-qR1WBdHc3hVhJnBeS6_lPdhKc9A/edit) 5 | 6 | Meeting Time: 7 | 8 | #### Chaoss Africa Developer Lead: **Enoch Kaxada** 9 | -------------------------------------------------------------------------------- /FOCUS GROUPS/designers-group.md: -------------------------------------------------------------------------------- 1 | # About 2 | This is the Chaoss Africa Design Subgroup. 3 | ## You can access the different documents below 4 | - Read about the Design group in the [onboarding document](https://docs.google.com/document/d/1UHaG5C3_E9U4fMjryvVeIN-UjcGJkBoQsY6k2-916H8/edit) 5 | 6 | - Ongoing Project - [Badging Website](https://www.figma.com/file/7tiuJbwakgDu15mOjzKTDK/Badging-Website) 7 | 8 | Meeting Time: 9 | 10 | #### Chaoss Africa Design Lead: **Kingsley Mkpandiok** -------------------------------------------------------------------------------- /FOCUS GROUPS/researchers-group.md: -------------------------------------------------------------------------------- 1 | # About 2 | This is the Chaoss Africa Researchers Subgroup. 3 | 4 | ## You can access the different documents below: 5 | - Read about the researcher's group in the [onboarding document](https://docs.google.com/document/d/1uAWrbeKoV82xrgVCkh-67VE4PYh9BsW4Y6gRFVkhnAo/edit#heading=h.ig1n5k2k62sv) 6 | 7 | - We track our work [here](https://docs.google.com/document/d/1qpp2SSPS9eo5X_LTsmclG5O4nLpxqRwOagmgiOF2hPQ/edit) 8 | 9 | Meeting Time: Biweekly on Wednesdays at 11:00 am WAT 10 | 11 | #### Chaoss Africa Researchers Leads: **Lami Williams and Adeyinka J. Oresanya** 12 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: chaoss-africa 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 13 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 14 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2022 CHAOSS 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Chaoss-Africa 2 | 3 | ## Why CHAOSS Africa? 4 | 5 | This community aims to empower people to become integrated into the CHAOSS project, contribute in meaningful ways to them and the project, and help build a solid CHAOSS global community. 6 | 7 | ## What does the community focuses on? 8 | 9 | - Discover the unique challenges of OSS Communities in Africa and create initiatives around them. 10 | - Work on CHAOSS Software projects, documentation, metrics, and design. 11 | 12 | ## How we work 13 | 14 | We have focus groups for different tech skillsets: 15 | 16 | - Developers Focus Group 17 | - Designers Focus Group 18 | - Community Managers Focus Group 19 | - Research/Data Analysts Focus Group 20 | - Technical Writers Focus Group 21 | 22 | ## How to Participate or Contribute? 23 | 24 | - Join the [CHAOSS Slack](https://join.slack.com/t/chaoss-workspace/shared_invite/zt-r65szij9-QajX59hkZUct82b0uACA6g), search for #chaoss-africa channel, join, introduce yourself and indicate what focus group you want to participate in. 25 | - Join us on our Bi-weekly community sync, Thursdays, 3PM WAT at [CHAOSS Zoom](https://zoom.us/my/chaoss) 26 | - Follow us on [@chaoss_africa](https://twitter.com/chaoss_africa) on Twitter 27 | - Have an idea, feel free to open a GitHub issue on this repository or contribute to the existing issues. 28 | -------------------------------------------------------------------------------- /CHAOSS Glossary.md: -------------------------------------------------------------------------------- 1 | # Welcome to CHAOSS Glossary 2 | The Dictionary to everything with an acronym here in [CHAOSS](https://chaoss.community/) 3 | 4 | # The Glossary 5 | We understand the struggle in reading and understanding everything from a holistic point of view. Here are some of the Acronyms you might come across as a contributor: 6 | 7 | - CHAOSS: Community Health Analytics in Open Source Software 8 | - MD: Markdown 9 | - OSS: Open Source Software 10 | - PR: Pull Request 11 | - FG: Focus Group 12 | - SDG: Sustainable Development Goals 13 | - WG: Working Group 14 | - DEI: Diversity, Equity, and Inclusion e.g., DEI Badging 15 | - UN: United Nations 16 | - FOSS|FLOSS: Free Open Source Software 17 | - LFx: Linux Foundation 18 | - OSI: Open Source Initiative 19 | - OSOSS: Open Standards and Open Source Software 20 | - MIT: Massachusetts Institute of Technology 21 | - CI/CD: Continuous Integration/Continuous Deployment 22 | - API: Application Programming Interface 23 | - MD.File: Markdown File e.g., Contributor.md 24 | - FOSDEM: Free and Open source Software Developers' European Meeting 25 | - OSCA: Open Source Community Africa 26 | - Repo: Repository 27 | - *CON: Conference e.g., CHAOSScon 28 | - CHAOSScast: CHAOSS Podcast 29 | - Hacktoberfest: A month-long celebration of open-source projects, their maintainers, and the entire community of contributors usually done in October. 30 | - Pycon: Python Conference 31 | 32 | -------------------------------------------------------------------------------- /Hacktoberfest/FromZeroTo100.md: -------------------------------------------------------------------------------- 1 | 2 | ### Overview 3 | 4 | This training is part of Hacktoberfest celebrations — a time where contributors across the globe come together to celebrate open source. 5 | 6 | From Zero to 100: A Technical Writing and Open Source Documentation Training is a 4-hour interactive training designed to introduce participants to the world of technical writing and open source documentation. Expect a blend of talks, best practices, and hands-on breakout sessions to help you be a confident technical writer and contributor to open source projects. 7 |

8 | 9 | ### Program Details 10 | 11 | Title: From Zero to 100: A Technical Writing and Open Source Documentation Training
12 | Date: 18th October 2025
13 | Time: 12-4 pm UTC | 4-8 am Pacific time
14 | Duration: 4 hours
15 | Format: Talks + Breakout Sessions
16 | Platform: Zoom (link will be shared with registered participants)
17 | Registration link: https://forms.gle/F5T3pwMxEUMgCGrL6 18 |

19 | 20 | ### Who attended? 21 | 22 | Beginners curious about open source and technical writing 23 | Writers, designers, or developers interested in documentation 24 | Anyone looking to start contributing to open source projects through non-code contributions 25 |

26 | 27 | ### Pre-requisites 28 | 29 | * No prior experience writing or open source needed 30 | * Basic knowledge of a conference room, such as Zoom 31 | * Open mind for learning 32 |
33 | 34 | 35 | ## Program Agenda 36 | |Speaker name|Duration|Session title|Session Format|Time slot| 37 | |----------|----------|----------|----------|----------| 38 | | Peculiar Umeh| 10 mins |Introduction to CHAOSS | Talk| 1:05pm - 1:15pm| 39 | | Mankinde Mercy | 20 mins |Introduction to Technical Writing | Talk|1:15pm - 1:35pm| 40 | | Fortune Ikechi | 20 mins |How to write for Non-Technical Users | Talk|1:35pm - 1:55pm| 41 | | Prince Onyeanuna| 20 mins |How to choose the perfect documentation for your software product| Talk|1:55pm - 2:15pm| 42 | | Anita Ihuman | 25 mins |Beyond the Docs: Building a Career in Tech Through Technical Writing | Talk|2:15pm - 2:40pm| 43 | | Break! | Break! |Break! | Break!|2:40pm - 2:55pm| 44 | | Peace Sandy | 30 mins |Building Better Docs: A Practical Approach to Software Documentation| Breakout|2:55pm - 3:25pm| 45 | | Wisdom Nwokocha | 30 mins |Building docs with a static site generator | Breakout|2:55pm - 3:25pm| 46 | | Maryblessing Okolie | 30 mins |Before you Contribute: What every Contributor should check in Project Documentation| Breakout|2:55pm - 3:25pm| 47 | | Tabah Baridule | 30 mins |Building Easy-to-Use API Docs using Postman | Breakout|2:55pm - 3:25pm| 48 | | Buffer! | Buffer! |Buffer! | Buffer!|3:25pm - 3:30pm| 49 | | Shaun McCance | 25 mins |Open the Docs: Writing in Open Source Communities| Talk|3:30pm - 3:55pm| 50 | | Linda Ikechukwu | 25 mins |The Role of Storytelling in Technical Writing | Talk|3:55pm - 4:20pm| 51 | | Closing remarks | Closing remarks |Closing remarks | Closing remarks|4:20pm - 4:30pm| 52 |
53 | 54 | ### Code of Conduct 55 | This program is governed by the CHAOSS Project [code of conduct](https://chaoss.community/code-of-conduct/). Your registration for or attendance at the program indicates your agreement to abide by this policy and its terms. We encourage you to read through the code! 56 |

57 | 58 | 59 | ### Program Resources 60 | We’ll update resources like slides or exercises from speakers here. 61 |

62 | Here is a list of speakers slides: 63 | 1. [Power Slide](https://docs.google.com/presentation/d/1viCJqLJN4Yzqe7RxbyTeLly7ariFBOHIEiyKHtot4xM/edit?usp=sharing) 64 | 2. Makinde Mercy - [Intrduction to Technical Writing](https://gamma.app/docs/Introduction-to-Technical-Writing-ct9ud1ngdf1quvv) 65 | 3. Linkda Ikechukwu - [Story Telling in Technical Communication](https://www.canva.com/design/DAG0fnA1h4A/mHsVKsVVZJp4y4fKgYQ_dg/edit?utm_content=DAG0fnA1h4A&utm_campaign=designshare&utm_medium=link2&utm_source=sharebutton) 66 | 4. Anita Ihuman - [Beyond the docs: Building a career in tech through Technical Writing](https://www.canva.com/design/DAG2IjJJUQ4/suBVbUfSQN9u6tS5RtXJ2w/edit?utm_content=DAG2IjJJUQ4&utm_campaign=designshare&utm_medium=link2&utm_source=sharebutton) 67 | 5. Prince Onyeanuna - [How to choose the perfect Documentation for your software product](https://docs.google.com/presentation/d/1_ovK0CsCoU0V7AU8yFg469vZbeW3zJ13n9wrM9Hmfg4/edit?usp=sharing) 68 | 6. Okolie Blessing - [Before you contribute: What every contributor should check in project management](https://www.canva.com/design/DAG15nNuav0/adiAJj8PM17tF56cuaYW1w/edit?utm_content=DAG15nNuav0&utm_campaign=designshare&utm_medium=link2&utm_source=sharebutton) 69 | 7. Wisdom Nwokocha - [Building Docs with SSGs](https://drive.google.com/file/d/1ukKZl4Nqy5gJo4i8NkiHfsi8zpNK_2VA/view?usp=drivesdk) 70 | 71 | ### [Program Report](https://docs.google.com/presentation/d/1pOAiv18v7-lfCgn6x4-8dMS6lXbL6GbTdD6rn-9x708/edit?usp=sharing) 72 | 73 | 74 | ### Support & Contact 75 | For questions, reach out via issues on this repo or Slack to any of the people below 76 |
77 | 78 | [Moturayo](https://github.com/motuncoded)
79 | [Harmony](https://github.com/harmonyelendu/)
80 | [Maryblessing](https://github.com/maryblessing) 81 |

82 | 83 | ### Annex 84 | 85 | [Hacktoberfest Official Website](https://hacktoberfest.com/)
86 | [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) 87 | -------------------------------------------------------------------------------- /Hacktoberfest/DocScavanger.md: -------------------------------------------------------------------------------- 1 | **Doc Scavenger** is a HacktoberFest online program organized by the Technical Writers focus group in CHAOSS Africa. This event in clear terms is basically the scavenging (scouting) for issues, bugs and fixing them within documents in CHAOSS Repositories, Projects and Open Source at large. However it is safe to note that the team has provided issues that are classified as Hacktober Fest Worthy and you can find these issues in [CHAOSS Africa Github Repository](https://github.com/chaoss/chaoss-africa) repositories labeled accordingly. 2 | 3 | 4 | **Program Objectives** \ 5 | The following are the core objectives for the Doc Scavenger Program. 6 | - Improve and fix documentation issues within Repositories 7 | - Educate and enhance knowledge amongst newbies and existing Contributors 8 | - Increase collaboration and participation amongst contributors in documentations 9 | 10 | 11 | **Program Outline** \ 12 | We have curated a line up of activities ensuring that every part of Doc scavenger is impactful and educative to both New Contributors and existing Contributors beyond documentation. 13 | 14 | - 2 Days Virtual Workshop: There will be a Virtual Workshop on [12th Saturday](https://teamup.com/event/show/id/YNyTz7jvH7DgJUrR9Sdu2fiuNv4Kkt) and [13th Sunday October](https://teamup.com/event/show/id/ST8GZ4os6T5Lw39ncTYueC8sj7tB3M), 5pm - 6:30pm WAT. We will be having practical sessions on Creating issues, Creating Pull Requests, Explaining what to check out for proper documentation While providing a resources Bank for Documentation amongst Other things. 15 | 16 | - 14days Doc Challenge Sprint: While we will encourage you to go beyond 14 days, we will be documenting a 14 day, 1 hour Daily Doc Scavenging session from the 14th to 28th October 2024. The Process is simple: Create/Fix an issue, Share on our channel [HacktoberFest Channel](https://chaoss-workspace.slack.com/archives/C07PX1J47HQ) and any social media using these hashtags #hacktoberfest24 #docScavenger #CHAOSS. 17 | 18 | - Virtual Zoom Party: On the [29th October](https://teamup.com/event/show/id/XzTKoaiHbviEy6vF2k6M3n99Xnz9Vz), 5:00 pm WAT we will be gathering to celebrate and give feedback on everything we have done so far in our Challenge while recognising random selected PR’s. 19 | 20 | **How can I participate?** \ 21 | The following are curated guidelines just for you! 22 | - Visit the [CHAOSS Africa Github Repository ](https://github.com/chaoss/chaoss-africa) 23 | - Look for issues tagged/labeled with “HacktoberFest or Good First issue”. Please note this will be updated regularly 24 | - Once you find an issue that interests you, start by reading the details and engage with maintainers if you need clarifications 25 | - After resolving the issue, submit a pull request following this [guideline](https://opensource.com/article/19/7/create-pull-request-github) 26 | - To properly sign off your commits, Please follow the instructions in this [guide.](https://www.secondstate.io/articles/dco/) 27 | - You can use an @ to let a maintainer know that you are done with the assigned task and it is now ready for review 28 | 29 | **Activities to do** \ 30 | There are no specific requirements that qualify you to participate, but the following are activities you can do! 31 | - Improve various documentations (illustrations, diagrams and more) 32 | - Spot and Create issues within documents 33 | - Fix Created issues and create PR’s with a minimum goal of 2 (Quality > Quantity) 34 | - Create and Write articles related to Open Source and CHAOSS Projects ( Examples: Tools Onboarding Docs, Feature and Tool Highlight etc) 35 | - Share, Comment, and Support Posts that involve Doc Scavenger 36 | 37 | **Submission Gudielines** \ 38 | The following guidelines has been curated to enable your submission process 39 | - Indicate interest on a particular issue with a comment 40 | - Once it's assigned, you can kick off 41 | - Present a link to your work in the comment section then tag a reviewer to go through (be sure to add your name in your file for credits to be given in case of article or blog wiritng) 42 | - Once approved, create a pull request or close issue. 43 | 44 | **Support | Reviewers** \ 45 | To get support or a review on your submissions, do well to tag any of the following Github Handles in the comments 46 | - [Harmony Elendu](https://github.com/harmonyelendu) 47 | - [Busayo Ojo](https://github.com/busayo-ojo) 48 | - [Gift Uhiene](https://github.com/giftea) 49 | - [Precious Abubakar](https://github.com/misspee007) 50 | - [Sophia Ugochukwu](https://github.com/sophiaugo) 51 | 52 | **Tools and Applications** 53 | - Zoom: For the Virtual workshop hosting 54 | - Slack: Communication Center for conversation 55 | - Github: Contributions, Issue creations and tracking 56 | 57 | **Technical Resources** \ 58 | The following resources have been provided just for you! 59 | - [The Pocket Technical Writing List](https://github.com/rubymorillo/pocket-tech-writing-list) 60 | - [Getting Started With Markdown](https://www.markdownguide.org/getting-started/) 61 | - [Awesome Technical Writing](https://github.com/BolajiAyodeji/awesome-technical-writing) 62 | - [Learn API Documentation](https://idratherbewriting.com/learnapidoc/) 63 | - [Paid Community Writer Programs](https://github.com/malgamves/CommunityWriterPrograms) 64 | - [Technical Writing A to Z](https://www.freecodecamp.org/news/technical-writing-for-beginners/) 65 | - [Technical Article Guideline Template](https://github.com/iamfortune/Technical-Article-Guideline-Template) 66 | 67 | -------------------------------------------------------------------------------- /Hacktoberfest/Hacktoberfest.md: -------------------------------------------------------------------------------- 1 | # CHAOSS Africa Hacktoberfest 2024 2 | 3 | Welcome to Hacktoberfest 2024 with CHAOSS Africa! Whether you're new to open source or an experienced contributor, we're so excited to have you join us 🎉 4 | 5 | This guide will help you get started and make the most of your Hacktoberfest contributions. 6 | 7 | Please ensure to read our [code of conduct](https://chaoss.community/code-of-conduct/) first! 8 | 9 | ## What is Hacktoberfest? 10 | 11 | Hacktoberfest is a month-long celebration of open-source software that happens every October. It's an excellent opportunity to get involved in the open-source community, contribute to projects, and learn valuable skills. 12 | 13 | ## Ways to Contribute 14 | 15 | There are several ways to contribute to CHAOSS during Hacktoberfest: 16 | 17 | ### 1. **Developers** 18 | 19 | As a developer, you can find open issues to improve the CHAOSS Africa repository. Here's how to get started: 20 | 21 | * Visit the [CHAOSS Africa GitHub repository](https://github.com/chaoss/chaoss-africa). 22 | * Look for issues tagged with the `Hacktoberfest` or `Good First Issue` labels. 23 | * Once you find an issue that interests you, start by reading the details and engaging with maintainers if you need clarification. 24 | * After resolving the issue, submit a pull request following this [guidelines](https://opensource.com/article/19/7/create-pull-request-github). 25 | * To properly sign off your commits, please follow the instructions in this [guide](https://www.secondstate.io/articles/dco/) 26 | * You can use an @ to let a mainataner that you are done with the assigned task and it is now ready for review. 27 | 28 | If you need further help, get in touch with [adeyinkaoresanya](@adeyinkaoresanya) 29 | 30 | ### 2. **Technical Writers** 31 | 32 | Love working with documentation? Passionate about explaining technical concepts clearly and concisely? 33 | 34 | Participating in our [**Document Scavenger Program**](./DocScavanger.md) is the perfect way for you to contribute. 35 | 36 | If you need further help, get in touch with [harmonyelendu](@harmonyelendu) 37 | 38 | ### 3. **Social Media Management** 39 | 40 | Do you have a knack for social media? This is your chance to refine those skills while promoting open source. How to get started: 41 | 42 | * Make a copy of the social media [content calendar ](https://docs.google.com/spreadsheets/d/1oBy3BKXHOvB_JHDwCS_BGicaZ2NISbZ5DCvi1q-h4WY/edit?usp=sharing) 43 | * Create your captions 44 | * To showcase and submit your amazing contributions, use this [form](https://forms.gle/MYLzfKjfWg9huK7y5) 45 | 46 | If you need further help, get in touch with Oluchi Nwankwo 47 | 48 | ### 4. **Design and User Experience (UX)** 49 | 50 | Designers, we need your expertise! If you have experience in UI/UX design, this is how you can contribute: 51 | 52 | * **Create or Improve UI/UX Designs**: Think there’s a user interface that could be better? 53 | * Visit the [CHAOSS Africa GitHub repository](https://github.com/chaoss/chaoss-africa) 54 | * Look for issues tagged with the `Designers` `Hacktoberfest` or `Good First Issue` labels 55 | * Once you find an issue that interests you, start by reading the details and engaging with [iamkingsleey](@iamkingsleey) if you need clarification. Your ideas could shape how thousands of users interact with CHAOSS. 56 | 57 | ### 5. **Education** 58 | 59 | CHAOSS Education is an ongoing project which will be delivered through short, informative videos and interactive workshops! Here's how you can contribute: 60 | 61 | * **Create or Contribute to Video Recordings**: 62 | Our video library is constantly growing! Become part of the process by tackling any of these interesting [issues](https://github.com/chaoss/education/issues) 63 | 64 | If you need further help, get in touch with [peculiaruc](@peculiaruc) 65 | 66 | ### 6. **Project Management** 67 | 68 | If you're a project manager, here's how you can contribute: 69 | 70 | * Look through this [spreadsheeet](https://docs.google.com/spreadsheets/d/1CbsVl8uFsxdSz57khz9wlgW_o2uZN_oOkA_w1dGT-v8) to find projects and teams that need project managers: 71 | * Task Coordination: Assist in organizing and assigning tasks for contributors, making sure issues are clear and manageable. 72 | * Read this documentation for further [hacktoberfest guidelines](https://docs.google.com/document/d/1OSiz_7aSen-2G5JSjHNWRxpLyXk3VcXBajg9x4MFd5k) 73 | 74 | If you need further help, get in touch with [Yiga](@yigakpoa) 75 | 76 | ## How to Contribute 77 | 78 | Follow these steps to start contributing to CHAOSS Africa during Hacktoberfest: 79 | 80 | 1. **Register for Hacktoberfest**\ 81 | Sign up on the official [Hacktoberfest website](https://hacktoberfest.com) to participate. 82 | 83 | 2. **Set Up GitHub**\ 84 | If you don’t have a GitHub account yet, [create one](https://github.com/join). Make sure to configure Git and familiarize yourself with GitHub basics, such as forking repositories, creating pull requests, and committing changes. 85 | 86 | 3. **Join Our Community**\ 87 | Get involved with our community on Slack. Introduce yourself and tell us what you do. Feel free to [Join here](https://chaoss-workspace.slack.com/archives/C07PX1J47HQ). 88 | 89 | 4. **Submit Your Contribution**\ 90 | For developer and technical writers submit your work via a pull request on GitHub - make sure to reference Hacktoberfest in your contribution notes so that the team know to add the `hacktoberfest-accepted` label. 91 | 92 | ## Contribution Tips 93 | 94 | * Make sure to review the issue and discuss any uncertainties with maintainers before submitting. 95 | * Stick to one issue at a time to ensure focused contributions. 96 | * Be respectful and patient with maintainers—they’re volunteering their time. 97 | 98 | ## Useful Resources 99 | 100 | * [CHAOSS Africa GitHub Repository](https://github.com/chaoss/chaoss-africa) 101 | * [CHAOSS Slack](https://chaoss-workspace.slack.com/archives/C07PX1J47HQ) 102 | * [CHAOSS Code of Conduct](https://chaoss.community/code-of-conduct/) 103 | * [For no Code Contributors](https://github.com/chaoss/community/blob/main/community-contributions.md) 104 | * [Hacktoberfest Website](https://hacktoberfest.com/) 105 | 106 | ## Partnerships 107 | 108 | If your organization is interested in partnering with CHAOSS Africa during Hacktoberfest, please reach out to [Busayo Ojo](mailto:ojobusayo99@gmail.com). 109 | 110 | *** 111 | 112 | We can’t wait to see your contributions and celebrate your achievements throughout Hacktoberfest! 113 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to CHAOSS Africa 2 | 👍🎉 First off, thanks for taking the time to contribute! 🎉👍 3 | 4 | ## What is this document? 5 | 6 | This document outlines a generic process of contributing and applies to all CHAOSS repositories. Each repository may have unique guidelines specific to the project, but this document serves as a primer for what is required when contributing to CHAOSS. 7 | Use your best judgement, and feel free to propose changes to this document in a pull request 8 | 9 | ## Who can contribute? 10 | 11 | Anyone can contribute to CHAOSS on any of our communication channels. See to learn more about how to participate. We are excited to meet first-timers and we are always ready to support you during your contribution journey. 12 | 13 | ## Which channel should I use? 14 | CHAOSS uses the following channels for contributions: 15 | 16 | - Mailing Lists 17 | - Community calls 18 | - Working group calls 19 | - GitHub 20 | 21 | ## Catch us online 22 | 23 | - [CHAOSS on the Web](https://chaoss.community) 24 | - [CHAOSS on GitHub](https://github.com/chaoss) 25 | - [CHAOSS on LFX Crowdfunding](https://crowdfunding.lfx.linuxfoundation.org/projects/a4a43b66-f707-47b4-97cc-484285c274a8) 26 | - [CHAOSS on Open Collective](https://opencollective.com/chaoss) 27 | - [CHAOSS Podcast](https://podcast.chaoss.community/) 28 | - [CHAOSS on YouTube](https://youtube.com/c/CHAOSStube) 29 | - [CHAOSS on Twitter](https://twitter.com/chaossproj) 30 | - [CHAOSS on LinkedIn](https://linkedin.com/company/chaoss/) 31 | 32 | ### Conversations and high-level contributions (email, call, face to face) 33 | 34 | Strategic directions, clarifications of scope, and ideas in an early stage are best discussed on the mailing list, calls, and face-to-face meetings. See . 35 | 36 | ### Bug report and feature request contributions (issue) 37 | 38 | Bug reports and specific feature requests are best discussed in an issue on the repository they pertain to. You can do this by creating an issue and explaining what bug you found in the comment section. The conversation moves from there. 39 | 40 | ### Code or document change contributions (GitHub User Interface) 41 | 42 | Changes can be made from within the GitHub user interface. As a non-maintainer, GitHub will create a fork under your name and ask that you create a pull request. The pull request lets the repository maintainers know of your change and provides a space to discuss the change. 43 | 44 | The [CHAOSS Charter](https://github.com/chaoss/governance/blob/master/project-charter.md) requires that contributions 45 | are accompanied by a [Developer Certificate of Origin](http://developercertificate.org) sign-off. 46 | For ensuring it, a bot checks all incoming commits. 47 | 48 | A DCO sign-off is accomplished by writing into the commit comment field: 49 | 50 | `Signed-off-by: Your Name ` 51 | 52 | It should be noted that the angled brackets `<` and `>` need to be included with the email. 53 | 54 | This can be automated by using a browser plugin like 55 | [DCO GitHub UI](https://github.com/scottrigby/dco-gh-ui). 56 | 57 | #### Steps to use the DCO browser plugin 58 | The [DCO browser plugin](https://github.com/scottrigby/dco-gh-ui) is a handy tool to automatically sign commits created using GitHub. 59 | To enable this plugin: 60 | 61 | - Go to the plugin page on the [chrome web store](https://chrome.google.com/webstore/detail/dco-github-ui/onhgmjhnaeipfgacbglaphlmllkpoijo). 62 | - Alternatively, you could go to the [firefox addon page](https://addons.mozilla.org/en-US/firefox/addon/scott-rigby/) to add the extension to your browser. 63 | - Once you add the extension, right click on the extension in the toolbar of your browser and select `Options`. 64 | - A dialog box will open up as shown below. Fill in your GitHub name (not the handle) and email-id. 65 | 66 | - Then, whenever you perform a commit on GitHub, the line `Signed-off-by: Your Name ` will automatically appear in the commit description while making changes to a file as shown in the example below. A commit message can be added to the lines above the auto-generated sign-off. 67 | 68 | - Once you perform the commit and send a pull request, the commit will be verified and approved by the DCO bot. 69 | 70 | This plugin is non-intrusive and works only on GitHub. 71 | 72 | *If you forget to add the sign-off you can also amend a previous commit with the sign-off. For this, you need to clone the repository on your local machine and run `git commit --amend -s`. Because you have pushed your changes to GitHub already you'll need to force push your branch after this with `git push -f`.* 73 | 74 | ### Code or document change contributions (pull request) 75 | 76 | Changes to source code files or documents are best contributed and discussed in pull requests. Please look at the CONTRIBUTING.md files for repository specifics. 77 | 78 | In this process, make sure your [GitHub account][ssh] is setup [fork][fork] then locally [clone][clone] the repo: 79 | 80 | git clone git@github.com:/.git 81 | 82 | Create a [feature branch][fb] in your local repository: 83 | 84 | git checkout -b 85 | 86 | Make your change and commit the change (NOTE: with `-s` you sign-off on each commit, which is your [Developer Certificate of Origin](https://developercertificate.org/)): 87 | 88 | git add 89 | git commit -s -m "" 90 | 91 | *If you forget to add the sign-off you can also amend a previous commit with the sign-off by running `git commit --amend -s`. If you have pushed your changes to GitHub already you'll need to force push your branch after this with `git push -f`.* 92 | 93 | Push to your fork on GitHub: 94 | 95 | git push origin 96 | 97 | Then, [submit a pull request][pr] on GitHub to the CHAOSS repository. 98 | 99 | [ssh]: https://help.github.com/articles/connecting-to-github-with-ssh/ 100 | [fork]: https://help.github.com/articles/fork-a-repo/ 101 | [fb]: https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow 102 | [pr]: https://github.com/thoughtbot/factory_girl_rails/compare/ 103 | [clone]: https://help.github.com/articles/cloning-a-repository/ 104 | 105 | ### Pull Request Checklist 106 | 107 | - [ ] Check if your code addition will pass both code linting checks and unit tests. 108 | - [ ] Check if your documentation commits are free from typos. 109 | - [ ] Ensure your commit messages are descriptive. [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) explains how to write good commit messages. 110 | - [ ] Check the commits and commits messages and ensure they are free from typos. 111 | 112 | At this point, you are waiting on the CHAOSS repository maintainers. They will comment on your pull requests 113 | within three business days (and, typically, one business day). 114 | 115 | The CHAOSS repository maintainers will report on open issues and pull requests on the [calls and via the mailing list][participate] to elicit feedback from the community. 116 | 117 | [participate]: https://chaoss.community/participate/ 118 | 119 | 120 | 121 | 122 | 123 | --------------------------------------------------------------------------------