Monday, 21 December 2015

Bug, bug, there is a ladybug!

So, you found a bug? First ensure it is not a ladybug, as those should be set free and not fixed, nor reported, nor digested into tests etc. But when capturing a software bug, you have a few choices. Depending on your time and programming experience, you can choose how to contribute to the project.



Report a bug

Go to the GitHub issue tracker and report your findings. Please include the steps you took to reproduce the issue. Chances are, it eventually get fixed, unless the issue is specific to your environment or cannot be reproduced by following the steps provided.

You know how to write tests?

Great! Please write a test reproducing the issue. And I already included templates for thit case: bug_scenario_test.scala for the integration test and bug_component_test.scala for the unit test. Then please report the bug and attach your test files. High chances of it getting fixed as your tests reproduce the issue and provide the expected behaviour.

You know how to fix it?

For me, this is the best option as I do not have to do anything! Please fix the issue and ideally cover it with tests (refer to the section above). Then do a pull request!

I would really appreciate some feedback and comments on issues you encounter. You can email me with your findings, questions and feedback: cftp @ coldcore.com

Summary

Remember not to fix ladybugs. They are fine as they are, for what they were designed as being!

No comments:

Post a Comment