draeger-lab
LSODAIntegrator.java is not follow Java conventions.
SSIA First of all, thanks to @NeumannArthur for putting together the initial implementation of LSODAIntegrator.java. It's a great starting point for getting things up and running. That said, there are a few areas where we can improve the code to align more closely with standard Java conventions and software engineering principles. For example, it's currently using System.out.println for logging and not throwing exceptions when errors occur. I think it's worth refactoring to make the codebase more robust and maintainable going forward.
Dear @TlexCypher , Apologies for the late reply. I’ll begin working on the suggested improvements starting today. Refactoring for better logging, exception handling, and overall code robustness sounds like a great opportunity to make the codebase cleaner and more maintainable.
Also, while updating the tests, are there any other key tips or best practices you'd recommend I keep in mind to ensure they remain effective and aligned with the project standards?
Looking forward to your guidance!
Hey @TlexCypher , I have sent an email regarding some changes. Kindly check it when possible. Thanks!
@Aditya201003 Sorry for late response, I was so busy this week, so no room to back any response. I will suggest you use the method called TDD(Test Driven Development). Thank you for continuing contribution!
Hey @TlexCypher No worries at all, I completely understand! Thanks for the suggestion — I’ll make the changes using TDD and raise a PR as soon as possible.
@Aditya201003 Thank you for reply. You need to meaningful testcases when you adopt TDD. If you are not familiar with TDD, this is one of the great references, https://www.amazon.co.jp/-/en/James-W-Grenning/dp/193435662X.
Hey @TlexCypher , I've opened a PR for this issue—this update mainly focuses on improving method names and adding appropriate logger statements for better clarity and debugging. I wish to merge this once it looks good, and then move on to adding more tests as the next PR.
Please take a look whenever you get a chance and let me know if any changes are needed. Happy to make revisions if required! PR Link - https://github.com/draeger-lab/SBSCL/pull/82 Thanks!