Developer TODO list

[lucydot]

TODO

Core

• linting!
• Restrict python versions as relying on dict type being ordered
• Rename choochoo student thread to choochoo checklist thread
• How to handle testing?
• Integration into an existing course repository #37
• Many:many mapping between objectives and questions using yaml + python dictionaries (mysql prob overkill)
• Separate out the choochoo repo from the choochoo-template project repo
• Automatically compile anything committed to main in questions/, tutorials/ or plots/ into html and publish on gh-pages
• Stop students from creating more than one checklist per person
• Access to Choochoo bot #38
• Allow admins to enable or disable the github pages branch
• Improve the github pages site #39
• Allow admins to enable or disable the student questions
• Post choochoo-bot error messages on the issue thread #43
• Encourage all contributors specification
• Only allow generate questions command in question thread
• print markdown lists (authors, objectives) with commas
• Google style docstrings and generate API documentation using https://mkapi.daizutabi.net/
• Change question_proposal and accepted_question. to question and then either accepted or proposed.
• Better testing of different gh_branch in settings - need to put into. workflow files for example?
• Rename "instructor" issue as "management" issue?
• When parsing choochoo commands strip whitespace
• Allow instructors/admins to generate question sets with a particular filename
• Add links to the question sets from the course webpage
• Update list commands output
• Change settings so that has owner and repo_name and auto build the website address, then can move to advanced.
• Add generated command and time to question sets (and plots)
• Make choochoo commands more robust: for example, allow trailing spaces.

Bugs

• choochoo check @X is instructor does not work

Improvements

• Improve integration setup - use submodule?
• Add question to multiple objectives
• Reduce the number of workflows triggered by not triggering deploy plots and deploy questions everytime choochoo is ran...
• call choochoo build question bank as part of choochoo bank question?
• Change all emojis to openmojis with attribution
• I think the two functions check_student and check_question in the fat controller workflow can be combined
• Re-structure objectives module so that the methods to create dictionaries are class methods (as in Question class)
• Document the commands in a table with columns: where can they be run, who can run them.
• rename add_student
• message if someone tries to generate more questions than are available
• have option to replace icon on the summary page
• change y-axis of summary plot to the objective number, then give objective when hovering over the bar
• More flexibility for the yaml input #44
• Don't allow instructors, admins etc to be added twice
• Command to summarise proposed questions, question votes and accepted questions
• Error handling, especially in env.py
• Add timestamp to the summary plot(s)
• Allow parsing of multiple usernames in the CLI #41
• Streamline the CLI #42
• Choochoo returns update messages to issue thread when command is executed
• Assign the issues to appropriate people (the people who raised them?)
• Enforce the vote-once rule for a proposed question (currently requires manual check before acceptance)
• Class hierachy diagram for easy visualisation
• Add links to author names in question bank (markdown) and on the issue thread
• Control which methods can be used with particular instance types of theissuse.Issue class #40
• when writing to settings.yml keep the same formatting as in original
• Add a choochoo list objectives command
• check link, question, tutorial new before adding them to an objective
• create function for long repeated code in add link (.+) to objective ([1-9]+) et al.
• all-contributors type system to recognise student contributions to the question bank?