An open-source developer gave a "best in class" answer to my bug report

 An open-source developer responded to a bug report in a way that has "I take engineering seriously" written all over it. I wish more software engineers gave this as their first response, including myself. This is the response I got from a platform-related defect.

That's certainly an issue! I'll try and add Windows to the CI tests so I can catch and fix these. I should be able to get to it later this week.

just updating to let you know that I'm working on this; the fix should be fairly simple, the harder part is just to get all the windows CI working so that I can confidently support windows/fix other issues that may come up. Should have a release done by end of weekend.

Why does this answer excite me?  

  • It isn't because they replied.  
  • It isn't because they take it seriously. 
  • It isn't because they are going to fix it. 
It excites me because 
  • They intend to fix it in a way that it never comes back and that provides a platform for future testing.

Chain of events to awesomeness

StepDiscussion
I opened a fairly specific bug report around software running on Windows when the development took place on Linux and Mac.The developer could have replied that they don't use Windows or that they didn't have time.  Both would have been valid.
The developer replied they would look into it and that they would add tests and CI This implies a whole level of software quality or software craft that is way better than the usual drop a code snippet in GitHub and write a blog. Only a couple of my projects have unit tests and none have CI?

There are a lot of professional in-house teams that would not jump to an end-to-end solution. How many times have you seen teams do the minimum fix with little or no testing or teams that don't have an interest in expanding their CI/CD environment for functional or additional testing?
The developer updated the bug report that they would consider this resolved when they had a CI environment and unit tests to support the platform.The developer provided an update. The update showed that it was only Done Done when they had tests and a test environment.

This means they know they don't functional regressions.

The actual defect

I reported a defect that the file path character "/" or "\" was incorrectly set when copying files from a windows machine to an SBC or Microcontrol in a Micropython environment.  File paths should have always been /pyboard/foo/bar and when copying from a windows machine they were copied as /pyboard\foo\bar

The actual effort 

  1. The developer created a Windows virtual machine.  
  2. Then they loaded a microcontroller simulator.  
  3. Then they loaded all the supporting libraries into that environment.  
  4. They integrated that virtual machine and emulator with their Continuous Integration / Continuous Development validation environment. 
  5. Then they created a fix on their local machine.  
  6. Committed the code to the repository and verified that their fix worked in the virtual machine and simulator created above.
  7. Set up the CI/CD so that it would spin up when they had future changes so that the test could verify nothing was broken.
  8. Communicated the status of the work and called out any additional issues that delayed the fix.  Most of the delays were in creating the CI/CD environment.

Revision History

Created 2023 01
Added "actual defect" and "actual" effort 2023 02

Comments

Post a Comment

Popular posts from this blog

Installing the RNDIS driver on Windows 11 to use USB Raspberry Pi as network attached

Image
I do a lot of my development and configuration via ssh into my Raspberry Pi Zero over the RNDIS connection. Some models of the Raspberry PIs can be configured with  gadget drivers  that let the Raspberry pi emulate different devices when plugged into computers via USB. My favorite gadget  is the network profile that makes a Raspberry Pi look like an RNDIS-attached network device.  All types of network services travel over an RNDIS device without knowing it is a USB hardware connection. A Raspberry Pi shows up as a Remote NDIS (RNDIS) device when you plug the Pi into a PC or Mac via a USB cable. The gadget  in the Windows Device Manager picture shows this RNDIS Gadget connectivity between a Windows machine and a Raspberry Pi. The Problem Windows 11 and Windows 10 no longer auto-installs the RNDIS driver that makes magic happen. Windows recognizes that the Raspberry Pi is some type of generic USB COM device. Manually running W indows Update  or  Update Driver  does  not  install the RNDI
Read more

Understanding your WSL2 RAM and swap - Changing the default 50%-25%

Image
The Windows Subsystem for Linux operates as a virtual machine that can dynamically grow the amount of RAM to a maximum set at startup time.  Microsoft sets a default maximum RAM available to 50% of the physical memory and a swap-space that is 1/4 of the maximum WSL RAM.  You can scale those numbers up or down to allocate more or less RAM to the Linux instance. The first drawing shows the default WSL memory and swap space sizing. The images below show a developer machine that is running a dev environment in WSL2 and Docker Desktop.  Docker Desktop has two of its own WSL modules that need to be accounted for.  You can see that the memory would actually be oversubscribed, 3 x 50% if every VM used its maximum memory.  The actual amount of memory used is significantly smaller allowing every piece to fit. Click to Enlarge The second drawing shows the memory allocation on my 64GB laptop. WSL Linux defaults to a maximum RAM size of 5
Read more

Almost PaaS Document Parsing with Tika and AWS Elastic Beanstalk

Image
The Apache Tika project provides a  library capable of parsing and extracting data and meta data from over 1000 file types.  Tika is available as a single jar file that can be included inside applications or as a deployable jar file that runs Tika as a standalone service. This blog describes deploying the Tika jar as an auto-scale service in Amazon AWS Elastic Beanstalk.  I selected Elastic Beanstalk because it supports jar based deployments without any real Infrastructure configuration. Elastic Beanstalk auto-scale should take care of scaling up and down for for the number of requests you get. Tika parses documents and extracts their text completely in memory. Tika was deployed for this blog using EC2 t2.micro instances available in the AWS free tier. t2.micro VMs are 1GB which means that you are restricted in document complexity and size. You would size your instances appropriately for your largest documents.   Preconditions An AWS account. AWS access id and secret key.
Read more