Skip to content

Latest commit

 

History

History
345 lines (204 loc) · 9.9 KB

CONTRIBUTING.md

File metadata and controls

345 lines (204 loc) · 9.9 KB

Contributing to Our Community-Driven Podcast

Welcome! We're excited to have you contribute to our community-driven podcast. Your ideas and content help shape our episodes, and we value your participation. This guide will walk you through how to contribute using GitHub Issues for ideas, Pull Requests (PRs) for content, and Discussions for brainstorming.

Table of Contents

Getting Started

Creating a GitHub Account

If you're new to GitHub:

  1. Sign Up: Visit GitHub Sign Up and create a free account.
  2. Verify Your Email: Check your email to verify your account.
  3. Set Up Your Profile: Customize your profile (optional but encouraged).

Understanding GitHub Basics

  • Repository (Repo): A project's folder containing all files and history.
  • Issue: A way to track ideas, enhancements, and tasks.
  • Pull Request (PR): A proposal to make changes to the repository.
  • Discussion: A forum-like space for open-ended conversations.

How to Contribute

Submit Ideas Using Issues

We use Issues to collect and manage ideas for future episodes.

  • What to Submit: Episode topics, questions, suggestions, and feedback.
  • Why Use Issues: Allows us to track, prioritize, and discuss ideas transparently.

Contribute Content via Pull Requests

If you want to contribute actual content (like scripts, show notes, or resources), use Pull Requests.

  • What to Contribute: Draft scripts, research notes, episode outlines.
  • Using the GitHub Website: You can make changes directly on GitHub without needing any additional software.

Use Discussions for Brainstorming

For ideas that aren't fully formed or need community input, use Discussions.

  • When to Use: Early-stage ideas, general questions, or to start a conversation.
  • Benefits: Collaborative space to refine ideas before formalizing them as Issues or PRs.

Step-by-Step Guides

Submitting an Idea through Issues

  1. Navigate to the Repository:

  2. Go to the Issues Tab:

    • Click on the "Issues" tab near the top of the page.

  3. Create a New Issue:

    • Click the "New Issue" button.

  4. Select an Issue Template:

    • Choose "Episode Idea" or "Question Submission" from the templates provided.

  5. Fill Out the Issue Form:

    • Title: Provide a concise and descriptive title.
    • Description: Include details about your idea or question.
    • Additional Information: Add any resources or context that might be helpful.

  6. Submit the Issue:

    • Click "Submit New Issue".

  7. Engage in Discussion:

    • We'll review your idea and may ask follow-up questions in the issue comments.

Contributing Content via Pull Requests

You can contribute content directly through the GitHub website:

  1. Navigate to the Repository:

  2. Fork the Repository:

    • Click the "Fork" button at the top right to create your own copy.

  3. Add or Edit Content:

    • Navigate to the file you want to edit (e.g., /scripts/episode-draft.md).
    • Edit File:
      • Click on the file to open it.
      • Click the "Edit this file" pencil icon.
      • Make your changes in the web editor.
    • Create a New File:
      • Navigate to the folder where you want to add a new file.
      • Click "Add file" > "Create new file".
      • Name your file and add your content.

  4. Propose Changes:

    • Scroll down to the "Propose changes" section.
    • Commit Message: Provide a brief summary of your changes.
    • Extended Description: Add more details if necessary.
    • Click "Propose changes".

  5. Create a Pull Request:

    • You'll be prompted to "Open a Pull Request".
    • Review your changes and ensure they are correct.
    • Click "Create Pull Request".

  6. Wait for Review:

    • We'll review your PR, provide feedback, or merge it into the main project.

Participating in Discussions

  1. Navigate to Discussions:

    • Click on the "Discussions" tab in the repository.

  2. Browse Existing Discussions:

    • See if there's already a conversation related to your idea.

  3. Start a New Discussion:

    • Click "New Discussion".
    • Choose a category that fits your topic (e.g., "Ideas", "Q&A").

  4. Fill Out the Discussion Post:

    • Title: Provide a clear and descriptive title.
    • Body: Explain your idea or question in detail.

  5. Post Your Discussion:

    • Click "Start Discussion".

  6. Engage with the Community:

    • Reply to comments and collaborate to refine your idea.

Community Guidelines

  • Be Respectful: Treat everyone with kindness and professionalism.
  • Stay On Topic: Keep discussions relevant to the podcast.
  • Be Constructive: Offer helpful feedback and suggestions.
  • No Harassment: Zero tolerance for harassment or discrimination.
  • Follow GitHub's Terms of Service: Adhere to GitHub's Community Guidelines.

Getting Help

New to GitHub?

Questions?

  • Open a Discussion: Use the "General" category in Discussions.
  • Contact Us: Email us at [email protected].

Acknowledgments

We appreciate every contribution, no matter how big or small.

  • Recognition:
    • We'll acknowledge contributors in podcast episodes or show notes.
    • Top contributors may be highlighted on our website.
  • Feedback:
    • We provide constructive feedback to help you grow and improve.

Additional Information

Issue Templates

To make it easier for you to submit ideas, we have pre-defined issue templates.

Episode Idea Template

When creating a new issue:

  1. Select "Episode Idea" Template.

  2. Fill in the Template Fields:

    ## Idea Summary

<!-- Briefly describe your episode idea -->

## Detailed Description

<!-- Provide more detail about the topic -->

## Why It's Interesting

<!-- Explain why this would make a great episode -->

## Resources

<!-- Include any relevant links or references -->

  3. Submit the Issue.

Pull Request Guidelines

When submitting a pull request:

  1. Ensure Your Content Aligns with Our Standards:

    • Check for spelling and grammar.
    • Ensure the content is appropriate and relevant.

  2. Use the Pull Request Template:

    ## Description of Changes

<!-- Provide a detailed description of your changes -->

## Related Issue

<!-- If your PR addresses an open issue, link it here -->

## Checklist

- [ ] I have read the **CONTRIBUTING** document.
- [ ] My content follows the style guidelines of this project.
- [ ] I have performed a self-review of my own content.
- [ ] I have included necessary comments and explanations.

  3. Submit the Pull Request:

    • We'll review it and provide feedback or merge it.

Using Discussions for Early-Stage Ideas

If your idea isn't fully formed or you'd like community input:

  1. Start a Discussion:

    • Navigate to the "Discussions" tab.
    • Click "New Discussion".

  2. Choose the Right Category:

    • Select "Ideas" for brainstorming.

  3. Outline Your Thoughts:

    • Provide as much detail as you can.
    • Ask open-ended questions to encourage discussion.

  4. Referenceable Conversations:

    • Each discussion has a unique URL you can share or reference later.

Tips for Using GitHub Website Effectively

  • Editing Files Online:

    • You can edit files directly in your browser without cloning the repository.

  • Branch Management:

    • When making changes, GitHub will automatically create a new branch in your fork.

  • Preview Changes:

    • Use the "Preview" tab to see how your markdown content will look.

  • Notifications:

    • Watch the repository to receive updates on issues and PRs.

FAQs

Do I need to know how to code to contribute?

No! Many contributions involve writing, idea generation, and discussion, which don't require coding skills.

Can I contribute anonymously?

GitHub requires an account to contribute. However, you can use a pseudonym if you prefer.

How do I stay updated on the status of my contribution?

  • Issues and PRs: You'll receive notifications for any updates or comments.
  • Project Board: Check the status of issues and PRs on our Project Board.

Final Notes

We believe in the power of community collaboration. By participating, you're helping us create richer, more engaging content. We value your time and effort and are committed to making the contribution process as smooth as possible.

Thank you for being part of our podcast journey!