Skip to content

Create CONTRIBUTING.md file for new contributors #3

@TrivCodez

Description

@TrivCodez

Description

Create a comprehensive CONTRIBUTING.md file to help beginners understand how to contribute to the project.

Task

  • Create CONTRIBUTING.md in the root directory
  • Include sections:
    • How to set up development environment
    • Code style guidelines
    • How to test changes
    • PR process
    • Issue reporting guidelines
    • Getting help

Why this is good for beginners

  • Improves project documentation
  • Helps future contributors
  • Markdown writing practice
  • Understanding open source contribution flow

Content requirements

  • Clear step-by-step setup instructions
  • Python virtual environment setup
  • Discord bot token setup
  • Code style (type hints, naming conventions)
  • How to test commands
  • PR checklist

Files to modify

  • Create: CONTRIBUTING.md

Acceptance Criteria

  • CONTRIBUTING.md created in root directory
  • Includes environment setup steps
  • Explains testing process
  • Describes PR workflow
  • Mentions code style requirements
  • Links to relevant resources (discord.py docs, etc.)
  • Written in clear, beginner-friendly language

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions