1 Contributing to the Code Club Guide

First off, thank you for considering a contribution to this guide! 💙

This is a community resource—built by facilitators, participants, and contributors like you. This document provides guidance on how to contribute meaningfully and respectfully. Please take a moment to read it.

1.1 What Can I Contribute?

1.1.1 Content Improvements

  • Fix typos or grammar: If the text is confusing or has errors, a PR with corrections is always welcome.
  • Add new tips, strategies, or examples: Share what worked (or didn’t work!) in your own Code Club. Real experiences are the heart of this guide.
  • Expand sections with participant voices: Add anonymized quotes, case studies, or lessons learned from your community.
  • Improve structure or navigation: If you think the guide could be organized better, suggest it via an issue first.
  • Update or add resources, links, or references: Is there a great tutorial, template, or tool we should mention? Let us know!

1.1.2 Design

  • Improve visual design: Suggest or implement changes to the SCSS that enhance readability or accessibility.
  • Create or improve illustrations/diagrams: Visual explanations are powerful for learning.
  • Enhance accessibility: Better alt text, color contrast, or markup for screen readers.

1.1.3 Documentation

  • Improve this Contributing guide: Make it clearer, more accessible, or more welcoming.
  • Add or update the README: Better explain the guide’s purpose or how to use it.
  • Create issue/PR templates: Help future contributors submit better contributions.

1.1.4 Translation

  • Translate the guide into other languages: Open science is global; help make this guide accessible to more communities.
  • Adapt for your institution or region: Fork the repo, customize for your context, and share back what you learn.

1.1.5 Non-Code Contributions

  • Share the guide in your networks: Tell colleagues, friends, and communities about this resource.
  • Give feedback via issues: Ask questions, point out confusing sections, or suggest topics we’re missing.
  • Participate in discussions: Engage with other contributors and help answer questions.

1.2 How to Get Started

1.2.1 1. Explore the Repository

  • Read the README.md to understand the project’s mission and scope.
  • Browse the index.qmd file to see the current guide content.
  • Look at existing issues to see what others are working on or what is needed.

1.2.2 2. Set Up Your Environment

To render and preview the guide locally, you’ll need:

  • Quarto (free, open source)
  • A text editor (VS Code, RStudio, Obsidian, or any markdown editor)
  • Git and a GitHub account

Local Setup: - Clone this repository:

git clone https://github.com/SORTEE/start-your-codeclub-guide.git
cd start-your-codeclub-guide

  • Render the site: quarto render

  • Preview locally: quarto preview The preview will open in your browser at http://localhost:3200/ (or similar). Edit the .qmd or .scss files, and changes will auto-refresh.

1.2.3 3. Check Existing Issues

Before starting work, look at the issue tracker to see if your idea is already being discussed. If not, consider opening an issue to discuss significant changes before investing time in a PR.

Good reasons to open an issue first: - Proposing a large new section or reorganization - Suggesting changes to the guide’s structure or tone - Reporting a bug or accessibility issue - Asking for feedback on an idea