Release procedure

RepRapFirmware is open source and all release and development versions are published here on github.

The repository contains three main branches which are actively used for development. These are structured to ensure end users are always presented with a working MASTER branch.

MASTER - this branch must always be in a fully working state, to the best of the developers' knowledge. No changes will be accepted to this branch, except when merging from the TEST branch.

TEST - this branch is used to prepare a version for release to MASTER branch. Once the developers are happy with a set of features/bug fixes, they are pushed to this branch ready for full testing (test procedure detailed below).

DEV - this branch is used by the developers to develop new features and fix known bugs. Commits to this branch are not guaranteed to work.

Pull requests

As an open source project, RepRapFirmware welcomes pull requests. When submitting pull requests, please ensure:

1. Coding standards as detailed in the README are adhered to.
2. Pull requests are directed at the TEST branch.

Test procedure

The following test procedure is used to verify commits to the TEST branch are ready to be merged to MASTER. This is intented to fully check the safety and functionality of the RepRapFirmware. Improvements to this procedure are welcome.

1. Do tests on a standard production machine, not one with any experimental alterations.
2. Create a clean install by both uploading the new firmware and erasing then installing the SD image.
3. Test on a standard PC installation, with all driver and software up to date.
4. Press the reset button and then open an Arduino Serial monitor.
5. Send an M115 and check that the firmware version reported is correct.
6. Check that the web interface loads.
7. Check that all the web interface buttons work.
8. Check that all the web interface variable displays work.
9. Check that web G Code upload works.
10. Print the uploaded file
11. Print all the G Code files on the SD card and make sure they work. If in a rush, just print the first few layers of each, but enough to check the part cooling fan functions as expected.
12. While printing, check that the Pause and Stop buttons work.
13. Delete the file you just uploaded
14. Close the Arduino serial monitor
15. Open Pronterface and connect it.
16. Check that all the Pronterface buttons work.
17. Check that all the Pronterface variable displays are correct.
18. Check that the G Code list is correct and that Pronterface can queue a file to print.
19. Check that the Pronterface Pause button works.
20. Check that Pronterface can upload G Code files, config.g and reprap.htm.
21. Set the hot end to 100 C. Pull a wire from the thermistor. Does the heater shut down (watch the Duet LEDs) and do you get a USB error message?
22. Set the hot end to 100 C. Short circuit the thermistor. Does the heater shut down (watch the Duet LEDs) and do you get a USB error message?
23. Set the bed to 50 C. Pull a wire from the thermistor. Does the heater shut down (watch the Duet LEDs) and do you get a USB error message?
24. Set the bed to 50 C. Short circuit the thermistor. Does the heater shut down (watch the Duet LEDs) and do you get a USB error message?