Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 3.15 KB

Developer_ReadMe.md

File metadata and controls

68 lines (49 loc) · 3.15 KB

For Developers: From the Developers of BudgetBot

Table of Contents
  1. Function Documentation
  2. Testing
  3. Code Coverage
  4. License
  5. Code Documentation
  6. How to Contribute
  7. Future RoadMap

Code Documentation by Functionality

For a detailed explanation of the code, follow the links below:

  1. Main Code File
    2. Features:
  2. Add
  3. Budget Delete
  4. Budget Update
  5. Budget View
  6. Delete
  7. Display
  8. Estimate
  9. Graphing
  10. Helper
  11. History

Testing

We use pytest to perform testing on all unit tests together. The command needs to be run from the home directory of the project. The command is:

python run -m pytest test/

Code Coverage

Code coverage is part of the build. Every time new code is pushed to the repository, the build is run, and along with it, code coverage is computed. This can be viewed by selecting the build, and then choosing the codecov pop-up on hover.

Locally, we use the coverage package in python for code coverage. The commands to check code coverage in python are as follows:

coverage run -m pytest test/
coverage report

License

This project is licensed under the terms of the MIT license. Please check License for more details.

How to Contribute

We would be happy to receive contributions! If you'd like to, please go through our CONTRIBUTING.md

For any feedback, issues, or bug reports, please create an issue here.

Future RoadMap

  • More content can be added for the way notifications can be displayed on the user front. This can be done to make the UI more interactive.
  • Recurring expenses feature can be added for faster addition of expenses instead of following the whole process of everytime.