Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 2.18 KB
Raw

Contributing to Discord Bot Handler

We're excited that you're interested in contributing to our Discord Bot Handler project! This document provides guidelines for contributing and aims to make the contribution process as smooth and pleasant as possible.

Getting Started

Before you begin, make sure you have:

  • A GitHub account
  • Basic knowledge of TypeScript and Discord bot development
  • Familiarity with the project's codebase (read through the documentation)

How to Contribute

You can contribute in several ways:

  1. Reporting Bugs:

    • Use the GitHub Issues section to report bugs.
    • Clearly describe the issue, including steps to reproduce and the expected outcome.
    • Include screenshots or code snippets if applicable.

  2. Suggesting Enhancements:

    • Submit enhancement suggestions through GitHub Issues.
    • Provide a clear description of the enhancement and its benefits.

  3. Pull Requests:

    • Fork the repository and create your branch from main.
    • Write clear, concise code and ensure it adheres to the project's coding standards.
    • Write a clear, detailed pull request description explaining your changes.
    • Ensure your code does not introduce new issues.

Coding Standards

  • Follow the existing code style.
  • Use meaningful variable and function names.
  • Comment your code where necessary.
  • Keep your changes concise and focused on solving a single problem.

Pull Request Process

  1. Update the README.md with details of changes if necessary.
  2. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request represents.
  3. Your pull request will be reviewed by the maintainers, who may request changes or provide feedback. Be responsive to feedback to ensure a swift review process.

Community Guidelines

Be respectful and inclusive. Treat everyone with respect and kindness, and foster an environment of collaboration and learning.

Questions?

If you have any questions or need assistance, feel free to reach out to the maintainers via Discord.

Thank you for your interest in contributing to our Discord Bot Handler, and we look forward to your contributions!