Conversation
|
Hey, maybe this is unsolicited advice, but I would strongly urge you to add a test if you add new end-user flags. Something is working if and only if it keeps working over time, and if you want to grow out rmtree with user-facing flags/features please add a test! This was the primary reason the original remarks fell apart at the end, it was unmaintanable because there was only one person who could really read the code and it was extremely difficult to add a change in that system without breaking something in a different location. If your code is implemented well, the test should be easy to write too. If you want, we can set up a call via Discord to set a test-env up for you, I've been working on tests for a good amount of time now so I think we can get quite far in only like 30-60 minutes :) |
|
Hey! I agree :), and it is planned but not yet started 😅. The first goal of this (and my MRs in rmscene/rmc) was to have a way to have my rm files "readable enough" as quickly as possible (i consider this achieved as i don't have significant issues in my files). The second phase is now to make this easy (or at least easier) to maintain and have a way to quantify how good it is. I don't know yet when I will have time to start working on that. But i have a couple of ideas on what i want to test: some kind of unit tests on the parsing of the files and some integration tests using the "correct" exported pdf from the remarkable (i don't know yet if that can work but i have ideas that i want to try - i started a really small thing and it, for now, gives me hope). This MR is more of a small adjustment so that if someone wants to use this with non v6 rm files, it will not crash. But in my head it is clear that the next thing i want to work on is tests and not, for instance, #4, Seb-sti1/rmc#4 or Seb-sti1/rmc#5 |
|
Well, that's good! Feel free to ping me on Discord, I've written test suites professionally, and am focusing on tests that test what actually matters. I'd love to pair program with you for one or two hours to get it out pretty fast. Helps that I know the problem space of remarkable and python too :p Writing tests for remarks has made such a massive improvement to the development experience! And such a major improvement to the quality of the application too! |
No description provided.