ClassClock
ClassClock copied to clipboard
Cleanup, Test and Document
Due to a lack of free time to work on this during the school year, there is some work that needs to be done to get ClassClock into a state that's more friendly for outside contributions including:
- [ ] finish the current work happening on the
developmentbranch so that it can be merged to master and that branch can be deleted (this repo is still transitioning to the "github flow" model rather than "git flow") - [X] merge the
unit-testingbranch intodevelopmentand write tests for a decent portion of the app - [ ] create a
docsfolder where more general documentation (such as to document design decisions, how to set up the app and database, and overall app structure) can live- https://esdoc.org/???
- [ ] create some documentation on how newcomers can get started and contribute to Classclock, including where to find the link to the slack workspace (on the website, https://classclock.app)
- [ ] figure out what software is needed to compile the existing inline doc comments into a viewable page
- [ ] if there is a lack of inline doc comments, add them
- [ ] optional but useful: maybe make a small landing page (maybe https://docs.classclock.app or https://developer.classclock.app) to link to all these different documentation sources (including the barely-there API docs)
- [x] use
flask-migrate(i think thats the name) to take a snapshot of the current Database schema so that Future schema changes can be easily applied to databases created under this version of the app