QuickFeed: Instant Feedback on Programming Assignments

Documentation

• Teachers that wants to use QuickFeed may wish to review the User Manual.
• Teachers may also want to copy the sign up instructions and lab submission instructions, and make the necessary adjustments for your course.
• For detailed instructions on installation of QuickFeed for a production environment, please see our Server Installation and Configuration.

Development

For detailed instructions on configuring QuickFeed for development, please see our Developer Guide.

We Accept Pull Requests

We are happy to accept pull requests from anyone that want to help out in our effort to implement our QuickFeed platform. To avoid wasted work and duplication of efforts, feel free to first open an issue to discuss the feature or bug you want to fix.

Style Guidelines

We chose to implement QuickFeed in Go and Typescript because these languages offer simplicity and type safety. We therefore require that certain style guidelines are followed when creating pull requests.

For Go, we expect code to follow these style guidelines and list of common mistakes:

• We use the golangci-lint linter in VSCode.

• Go Code Review Comments. In particular, note the section on how to Handle Errors, Mixed Caps, Variable Names.

For Typescript, we think these style guidelines look reasonable. Moreover, the formatOnSave and tslint.run options in VSCode should help maintain reasonable style.

Note that we currently violate the interface naming guideline by using the I prefix on some interfaces, and several of the other guidelines. We have started to rename these interfaces, and will eventually rename all such interfaces.