Contributing

Contributing to ChooChoo

Thanks for your interest in ChooChoo.

This project follows the all-contributors specification. Contributions of any kind are welcome! A full list of possible contribution types can be found here. You do not need to be an experienced programmer to help improve ChooChoo.

All ChooChoo contributors are asked to follow the Contributor Covenant Code of Conduct.

Project description

ChooChoo is a Checklist Tool for educators. ChooChoo encourages learning through self-assessment, collaboration and diagnostic teaching. Instructors can create checklists for their students to work through, linked to a question bank and tutorials. Students can make contributions to the question bank, and review the contributions of their peers. Real-time plots are used to summarise class progress and better target teaching towards the topics that students are struggling with.

Issue tracker

The ChooChoo issue tracker is used to maintain a to-do list for ChooChoo and ChooChoo-template improvements. If you have found a bug or have a suggested improvement that is not listed, consider raising an issue. If you would like to contribute but do not know where to start, take a look at the issues labelled good first issue.

Pull Requests

We are happily reviewing pull requests. To discuss proposed changes, please use the ChooChoo discussions page or get in contact with the project lead Lucy.

Contact

As a rule of thumb, the more public the information exchange, the better! With this in mind, we encourage you to use the ChooChoo discussions page or to raise an issue on the ChooChoo repository.

However we also understand that this public way of working is not suitable for everyone. As an alternative, you can get in contact with the project lead Lucy.

Acknowledgement

All contributions will be recognised on the README.md. You are encouraged to log your own contribution using the all-contributors bot. The project lead(s) will also maintain this list.