How to file bugs?

General Discussion
1

Hey guys,

I’ve found several bugs within the source, but have run up against questions with how to file them, as they aren’t feature requests or major show-stopping issues. What’s the best approach for filing to fix bugs in existing code? Filing an issue and pull request, or trying to get a discussion started here? I know developer time is a valuable commodity, and want to make the best use of it.

2

Quite easy:

  • If you have identified a real bug and are able to fix it, then post a PR on Github. Please take into account Contributing to Klipper - Klipper documentation, especially point 3
  • If you suspect a bug in a certain part of the code and can point to it but not fix it, post in the “Developers” category
  • If you suspect a bug but cannot relate to specific code, then post here in “General Discussion”:
    • Concise description of the misbehavior and the environment, e.g. MCU / printer-board, Host type and OS etc
    • How to reproduce on pristine main-line Klipper without any modifications / extras and latest GH commit
    • klippy.log showing it. If possible start a new log, provoke the issue and immediately after issue an M112 command. This will output additional information

Thanks for your contribution!

1 Like