Skip to content

Latest commit

 

History

History
121 lines (71 loc) · 4.59 KB

CONTRIBUTING.md

File metadata and controls

121 lines (71 loc) · 4.59 KB

Contributing to ClassMateBot

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to ClassMate Bot. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Code of Conduct

I don't want to read this whole thing, I just have a question!!!

How Can I Contribute?

Style Guides

Code of Conduct

This project and everyone participating in it is governed by the ClassMate Bot Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to any of the original team members listed at the bottom of README.md.

I don't want to read this whole thing I just have a question!!!

Reach out to one of the main contributors on Discord using their IDs:

  • Shikha Nair: incorgnito#5402
  • Pradhan Chetan Venkataramaiah: PrymMinistah#4253
  • Steve Jones: SteveJones92#6974
  • Alex Snezkho: Apollo#4953
  • Tanya Chu: TC#1784

Note: Due to the dynamic nature of Discord IDs, these may change without prior notice on this page.

We do not have an official message board at this time, however, we plan to have one if it will help future contributors!

How Can I Contribute?

Pull Requests

The process described here has several goals:

  • Maintain the projects quality

  • Fix problems that are important to users

  • Enable a sustainable system for the projects maintainers to review contributions

Please follow these steps to have your contribution reviewed by the maintainers:

  1. Include a clear and descriptive title.
  2. Include a description of the change.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Adding Commands

Commands can be added in the form of Cogs. View hello.py as a simple example of how a Cog can be added.

The basic structure is as follows:

class <NAME>(commands.Cog):

    def __init__(self, bot):
        self.bot = bot
        
    <COMMANDS RELATED TO THIS FILE>
    
def setup(bot):
    bot.add_cog(<NAME>(bot))

For more information on how to use cogs, refer to the Cogs Page

For more information on the API of discord.py you can use the API Reference Page

For general Knowledge of discord.py use the Documentation Page

Reporting Bugs

This section guides you through submitting a bug report for ClassMateBot. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior and find related reports.

How Do I Submit A (Good) Bug Report?

  • Use a clear and descriptive title for the issue to identify the problem.

  • Describe the exact steps which reproduce the problem in as many details as possible.

  • Provide specific examples to demonstrate the steps.

  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.

  • Explain which behavior you expected to see instead and why.

  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

  • If the problem is related to performance or memory, include a CPU profile capture with your report.

Style Guides

Git Commit Messages

  • Describe why a change is being made.

  • Describe any limitations of the current code.

  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")

  • Limit the first line to 72 characters or less

  • Link an issue to the change

Python Styleguide

Changes to TeachersPetBot Python code should conform to Google Python Style Guide.

All Python code is linted with Pylint. Ensure that before you commit any changes, your code passes all default pylint checks. Pylint can be installed with pip install pylint.

This document is adapted from the Atom Code of Conduct