Skip to content

Update contributing guide with improved walkthrough and clearer guidelines #356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 6, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jun 6, 2025

Enhanced the CONTRIBUTING.md file to provide better guidance for new contributors by adding a comprehensive "Getting Started" section and improving existing contribution guidelines.

Changes Made

Added "Getting Started - What do you want to do?" Section

  • Created a clear pathway section at the top with emoji icons and direct links
  • Provides immediate direction based on contribution type:
    • 🎉 Add a New Event
    • 📚 Add a New Resource
    • ✏️ Fix Typos or Content Issues
    • 🔧 Make Code Changes
    • 🚀 Set Up Development Environment

Enhanced "Making Code Changes" Guidelines

  • Distinguished between Minor Code Changes (bug fixes, UI tweaks, cleanup) and Structural Code Changes (new features, architecture changes)
  • Provided clear processes for each type:
    • Minor changes: Direct fork-and-PR workflow
    • Structural changes: Issue-first discussion workflow

Expanded "Fixing Typos or Content Issues" Section

  • Added comprehensive guidance on what to fix (spelling, broken links, outdated info)
  • Detailed where to look for different types of content
  • Included helpful tip about editing directly on GitHub
  • Made the section more welcoming and actionable

Benefits

  • New contributors can immediately understand how to get started
  • Clear distinction between different types of contributions reduces confusion
  • Better guidance reduces back-and-forth in PRs
  • Maintains all existing information while adding valuable structure

All tests pass and no breaking changes were introduced.

Fixes #247.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…lines

Co-authored-by: AndreaGriffiths11 <20666190+AndreaGriffiths11@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Update contributing guide Update contributing guide with improved walkthrough and clearer guidelines Jun 6, 2025
@Copilot Copilot AI requested a review from AndreaGriffiths11 June 6, 2025 21:19
Copilot finished work on behalf of AndreaGriffiths11 June 6, 2025 21:19
@AndreaGriffiths11 AndreaGriffiths11 marked this pull request as ready for review June 6, 2025 21:21
@Copilot Copilot AI review requested due to automatic review settings June 6, 2025 21:21
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the CONTRIBUTING.md to guide new contributors with a clearer starting point and improve existing contribution workflows.

  • Introduces a "Getting Started" section with direct links based on contribution type
  • Expands and restructures the "Fixing Typos or Content Issues" section with clear what/where/how guidance
  • Distinguishes processes for Minor vs Structural Code Changes under "Making Code Changes"
Comments suppressed due to low confidence (2)

CONTRIBUTING.md:108

  • The numbered list under '#### How to Fix' is misformatted, mixing bullet markers and numeric prefixes. Consolidate into a single consistent numbered list and use proper indentation for sub-points.
-2. Make your corrections

CONTRIBUTING.md:109

  • Remove the redundant misformatted list items ('-2.' and '-3.') from the 'How to Fix' section to avoid confusion, as they duplicate the properly formatted steps below.
-3. Submit a PR describing what you fixed

Copy link
Contributor

@AndreaGriffiths11 AndreaGriffiths11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@AndreaGriffiths11 AndreaGriffiths11 merged commit b851b96 into main Jun 6, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Error loading sessions

Retrying.

Successfully merging this pull request may close these issues.

Update contributing guide
2 participants