-
Notifications
You must be signed in to change notification settings - Fork 90
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Blog: Technical properties of sustainable software #2139
Blog: Technical properties of sustainable software #2139
Commits on Aug 19, 2024
-
WIP: Initial copy of text and starting to fill in
This is for betterscientificsoftware/bssw-blog-planning#35.
Configuration menu - View commit details
-
Copy full SHA for dc5e99f - Browse repository at this point
Copy the full SHA dc5e99fView commit details -
WIP: Finished basic formatting of copied text
I also added a little more text.
Configuration menu - View commit details
-
Copy full SHA for ef9e86e - Browse repository at this point
Copy the full SHA ef9e86eView commit details -
Finished first fairly complete draft
I still need to fill in some references and then I can do some more detailed editing. According to emails "count-words", this is currently 1935 words long. (The target is about 1500 so this could use some editing to reduce length.)
Configuration menu - View commit details
-
Copy full SHA for 3e1c928 - Browse repository at this point
Copy the full SHA 3e1c928View commit details -
Add hero image for tech properties of sustainable software blog article
NOTE: I generated this hero image with Google Gemini Advancec using the prompt: generate an cartoon image of software depicted as a set of gears and showing the hand of a mechanic with a wrench This was the third of three generated images. If there is a desire for different hero image, it should not be too hard to generate one.
Configuration menu - View commit details
-
Copy full SHA for 8a8d528 - Browse repository at this point
Copy the full SHA 8a8d528View commit details -
Configuration menu - View commit details
-
Copy full SHA for 8931966 - Browse repository at this point
Copy the full SHA 8931966View commit details
Commits on Aug 20, 2024
-
Configuration menu - View commit details
-
Copy full SHA for a02593a - Browse repository at this point
Copy the full SHA a02593aView commit details -
Configuration menu - View commit details
-
Copy full SHA for fa6193b - Browse repository at this point
Copy the full SHA fa6193bView commit details -
WIP: Move references to bottom
The tool wikize-refs.py is refusing the recognise the usage of the reference [se2s-book-2016]. Perhaps this will help?
Configuration menu - View commit details
-
Copy full SHA for c66dfbc - Browse repository at this point
Copy the full SHA c66dfbcView commit details -
Fix reference link for [se2s-book-2016]
The error was confusing but I misspelled one usage
Configuration menu - View commit details
-
Copy full SHA for 47e2792 - Browse repository at this point
Copy the full SHA 47e2792View commit details -
Run wikize_refs.py on references
This messed up the numbering and the links. But I can fix those manually in the next commit. I will not run this script on the file after this.
Configuration menu - View commit details
-
Copy full SHA for ca707b4 - Browse repository at this point
Copy the full SHA ca707b4View commit details -
Manually fix off-by-one reference numbering error caused by wikize-re…
…fs.py No sure what happened here but it was easy enough to fix manually. The tool wikize-refs.py needs more unit testing and test cases.
Configuration menu - View commit details
-
Copy full SHA for 0ab4728 - Browse repository at this point
Copy the full SHA 0ab4728View commit details -
NOTE: I also added some missing reference placeholders [???] in case I want to add those.
Configuration menu - View commit details
-
Copy full SHA for a6ae730 - Browse repository at this point
Copy the full SHA a6ae730View commit details -
These were left over from when I was using bullets for these paragraphs.
Configuration menu - View commit details
-
Copy full SHA for 4f2efa2 - Browse repository at this point
Copy the full SHA 4f2efa2View commit details -
Some more edits after light reading
This reduced the length a little but up to the end of the Summary section this is still 1931 words (according to emacs 'count-words').
Configuration menu - View commit details
-
Copy full SHA for 8f7c4f6 - Browse repository at this point
Copy the full SHA 8f7c4f6View commit details
Commits on Aug 22, 2024
-
All of the references should be complete now
Configuration menu - View commit details
-
Copy full SHA for 3c52a6d - Browse repository at this point
Copy the full SHA 3c52a6dView commit details -
Configuration menu - View commit details
-
Copy full SHA for d121ef2 - Browse repository at this point
Copy the full SHA d121ef2View commit details
Commits on Aug 26, 2024
-
Add bullets for usage of more tools, update references
I added mentions of code formatters and other tools like static analyzers and runtime memory checkers, as suggested by @ksbeattie. I also changed the reference from the book chapter "Testing of Scientific Software: Impacts on Research Credibility, Development Productivity, Maturation, and Sustainability" to shorter articles on the bssw.io site itself. (We should likely reference that book chapter in those other bssw.io articles.) I also added another reference related to testing and had to shift all of the latter references. (I could not use wikize-refs.py to do this because of the off-by-one issue.)
Configuration menu - View commit details
-
Copy full SHA for d21f5b6 - Browse repository at this point
Copy the full SHA d21f5b6View commit details -
Update info on software licenses
Added some more text as suggested in review by @ksbeattie. I also added a reference for more info on picking an open-source software license.
Configuration menu - View commit details
-
Copy full SHA for e7d2750 - Browse repository at this point
Copy the full SHA e7d2750View commit details -
Update text about core domain model documentation
Improving this text was suggested by @ksbeattie in his review.
Configuration menu - View commit details
-
Copy full SHA for ed72a82 - Browse repository at this point
Copy the full SHA ed72a82View commit details
Commits on Aug 31, 2024
-
Slated for September 2024 publication
Just need to fill in the day on Sept this gets published
Configuration menu - View commit details
-
Copy full SHA for ddbed24 - Browse repository at this point
Copy the full SHA ddbed24View commit details
Commits on Sep 1, 2024
-
I noticed a few things after letting this sit for several days, including a few typos that Grammarly.com missed.
Configuration menu - View commit details
-
Copy full SHA for 9285e5d - Browse repository at this point
Copy the full SHA 9285e5dView commit details
Commits on Sep 26, 2024
-
Configuration menu - View commit details
-
Copy full SHA for d338190 - Browse repository at this point
Copy the full SHA d338190View commit details -
Configuration menu - View commit details
-
Copy full SHA for a7cafa2 - Browse repository at this point
Copy the full SHA a7cafa2View commit details -
Configuration menu - View commit details
-
Copy full SHA for 9425981 - Browse repository at this point
Copy the full SHA 9425981View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7bd1138 - Browse repository at this point
Copy the full SHA 7bd1138View commit details
Commits on Sep 27, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 2791eac - Browse repository at this point
Copy the full SHA 2791eacView commit details -
Configuration menu - View commit details
-
Copy full SHA for bbef788 - Browse repository at this point
Copy the full SHA bbef788View commit details