👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to TeachersPetBot. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
I don't want to read this whole thing, I just have a question!!!
This project and everyone participating in it is governed by the TeachersPetBot Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to any of the original team members.
Reach out to one of the main contributors on Discord using their IDs:
- Ashwin Shankar: KillSwitcH#3065
- Kailash: kailash98 s#4696
- Shakthi Nandana : Shakthi#7711
- Aswin: Aswin#0436
- Kaushik: Jack$parr0w#0875
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!
This section guides you through submitting a bug report for TeachersPetBot. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Bugs are tracked as GitHub issues. After you've found a bug, create an issue detailing the steps for reproducing the bug.
Explain the problem and include additional details to help maintainers reproduce the problem:
- 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.
The process described here has several goals:
- Maintain TeachersPetBot's quality
- Fix problems that are important to users
- Enable a sustainable system for TeachersPetBot's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
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.
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