search

smiths / AIMSS

Assessing the Impact of MDE (Model Driven Engineering) and code generation on the Sustainability of SCS (Scientific Computing Software)
2 stars 2 forks source link

ICCS Paper, Digging Deeper: Complete Table 3. Commonly Recommended Artifacts in Software Development Guidelines #130

Closed smiths closed 2 years ago

smiths commented 2 years ago

@peter-michalski, if you have time, could you complete Table 3 (Commonly Recommended Artifacts in Software Development Guidelines) in the ICCS paper? I would like a checkmark when the artifact in the first column is used in the software guideline listed in the corresponding column. I completed the first row (LICENSE). I've listed the artifacts for each resource here:

https://gitlab.cas.mcmaster.ca/SEforSC/se4sc/-/wikis/Advice-and-Checklists-for-Repos-(including-a-list-of-recommended-artifacts)

Not every source from the above web-page has a corresponding column in the table, just the major ones. Not every entry in the web-page made it to a row of the table. Somethings are too minor to include. When filling in the rows, the entry in the table should be interpreted broadly. If the entry in the table says "design", then any design document can be included with a checkmark. I put INSTALL etc in ALLCAPS. If a resource recommends the information that would go in the INSTALL file, but doesn't actually name this file, you should still put a checkmark.

The deadline for the paper is 6 pm tomorrow (Friday, Feb 18). To be safe, I'd like the table done by noon tomorrow. If you can't get to it, just let me know.

peter-michalski commented 2 years ago

@smiths I'll have this done tonight.

smiths commented 2 years ago

Great! Make sure you do a fresh pull before starting because I'll be working on the paper tonight as well. :smile:

peter-michalski commented 2 years ago

@smiths Thanks for letting me know. I notice that there is CONTRIBUTING and Contributing Guide. Should one be removed?

smiths commented 2 years ago

Good catch. Yes. Let's keep CONTRIBUTING to match the other ALLCAPS conventions.

peter-michalski commented 2 years ago

@smiths Added in 1c273a432df17c0e340cdaa792066700ff6b9fa1 and 2c3a60ff7d019af5a50f945d703a4a3e2ad1ed18

smiths commented 2 years ago

Looks great! Thank you @peter-michalski.

I'm aiming to have a complete draft of the paper done tonight. If you have time, it would be great if you could do an editorial pass tomorrow. I'll let you know when it is ready. (The challenge right now is to get the paper down to 14 pages!)