Blog: Technical properties of sustainable software #2139
Conversation
I also added a little more text.
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.)
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.
The tool wikize-refs.py is refusing the recognise the usage of the reference [se2s-book-2016]. Perhaps this will help?
The error was confusing but I misspelled one usage
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.
…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.
NOTE: I also added some missing reference placeholders [???] in case I want to add those.
These were left over from when I was using bullets for these paragraphs.
bartlettroscoe
added
the
preview
|
I merged this to 'preview' and rebuilt the preview site. The article shows up at: The formatting looks okay and the hero image looks okay. It think it could use another reading with some more edits but I would like to see what others think about this first. (But in the meantime, I can add a couple more references.) |
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').
All of the references should be complete now
|
Hello @betterscientificsoftware/bssw-editorial-board, would one of you be willing to review this blog post? The generated file for preview.bssw.io can be seen at: |
Articles/Blog/2024-08-TechnicalPropertiesOfSustainableSoftware.md
Outdated
Show resolved
Hide resolved
Articles/Blog/2024-08-TechnicalPropertiesOfSustainableSoftware.md
Outdated
Show resolved
Hide resolved
Articles/Blog/2024-08-TechnicalPropertiesOfSustainableSoftware.md
Outdated
Show resolved
Hide resolved
|
@ksbeattie, thanks for the review! I will respond to your individual comments and make some changes based on your feedback. I will do that after I post the PR for the CC article for #2110. |
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.)
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.
Improving this text was suggested by @ksbeattie in his review.
|
@ksbeattie, I added some commits to address your review comments. @rinkug, hopefully this is ready to publish? (it just needs to have the publication date update in the *.md file). |
|
@betterscientificsoftware/bssw-maint, this should be ready to publish. (See above checklist.) NOTE: I addressed @ksbeattie's comments but technically he signed off on the PR as it was, so, unless I made some mistakes with the new commits, this should be ready to publish. |
|
Thanks @bartlettroscoe and @ksbeattie for bringing this to closure! We got an article in about the ACM REP conferences that I want to push out first. That was held in June, so it will seem more timely the sooner we can get it out. I'll probably put this one out in the early September slot. |
@bernhold, sounds good to me. (And that will give me a chance to read it again in a few weeks and improve it more before it gets published 😊) |
Just need to fill in the day on Sept this gets published
I noticed a few things after letting this sit for several days, including a few typos that Grammarly.com missed.
Description
EB Member: @ksbeattie
Resolves https://github.com/betterscientificsoftware/bssw-blog-planning/issues/35
Blog article "Technical Properties of Sustainable Software".
PR checklist for files displayed on bssw.io site
@mentionthe BSSw.io editorial board member@<eb-member-id>in Description above assigned to shepherd your PR.<issue-id>in the Description above for the associated GitHub Issue.wikize_refs.py -i <base>.mdis run and commit (if using wikize_refs.py) ... Can't run again due to issue withwikize-refs.py*.mdfile(s) as rendered in GitHub for this PR.<eb-member-id>.<pr-author-id>.content: <content-type>for the type of contribution.Content Development(see Content Development).*.mdfile(s) (setPublish: yes).preview(so PR branch will be merged to 'preview' branch and watch for possible merge failures).[ ] [Author] Ensure... Can't run again, see abovewikize_refs.py -i <base>.mdis run and commit (if using wikize_refs.py).@betterscientificsoftware/bssw-maint(BSSw Maint) asking to carry out final publication steps.NOTE:
@betterscientificsoftware/bssw-maintteam (hint: type@,b,s,s,w,-,mto auto-complete to@betterscientificsoftware/bssw-maint).