Follow the set of guidelines below to contribute to MyExpenseBot!
By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
Prerequistes required before starting this project
If you're doing this as part of CSC510 - SE for Fall'23, then:
- Have good understanding of Python Programming Language and Telegram Bots
If you like our project and would like to contribue otherwise, please note:
- This project is created as part of CSC510 Coursework at NC State for Fall'23.
- If you like to contribute, reach out to the maintainers before creating a branch, to confirm if we're still maintaining the repo.
- Have good understanding of Python Programming Language and Telegram Bots
This section guides you through submitting a bug report for MyExpenseBot. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior and find related reports.
Before Submitting A Bug Report
Check the debugging guide
Check the FAQs on the forum for a list of common questions and problems. Determine which repository the problem should be reported in.
Perform a cursory search to see if the problem has already been reported.
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.
Any suggesting enhancements like adding new features or imporving existing functionalities, etc can done by following the below guidelines. They help maintainers understand your improvement. The template- this template is to be filled to add suggestions. These can include the steps that you imagine you would take if the feature you're requesting existed.
beginner and help-wanted issues can help you getting started to contribute your first contribution:
[Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two. [Help wanted issues][help-wanted] - issues which should be a bit more involved than beginner issues.
The process described here has several goals:
Maintain the projects quality and ensure you have a code coverage of > 80%. Otherwise your PR will not be approved.
Fix problems that are important to users.
Enable a sustainable system for the projects maintainers to review contributions
Check the Projects tab for TO-DO list and pick the feature you find interesting to work on.
Create a branch and implement the feature in Python using Telegram bot and test it locally. (Check the docs to learn more)
Write corresponding test cases to ensure it is not breaking the existing system.
Create pull request and request for the code review. Once the request is approved, merge to main.
Any suggestions to improve the bot is appreciated. Please add it to the TO-DO list.