insightsengineering / insightsengineering/framework-scientific-apps

Reviewer - poor connection from principles to case study

Open
#3 0 comments 0 reactions 0 assignees View on GitHub
reviewer feedback
Dominant language
TeX
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Similar from 2 reviewers

Reviewer A:
From the description of the poster it is unclear which of the principals they list contributed to what degree. Some principles loosely follow best practices of general code development (separating logic and UI, adding unit tests) but others less clear to the reader (limiting user inputs or being verbose on specific input cohorts).

Overall I believe the submission would benefit from more clarity and examples of the benefits. Perhaps an additional literature search or relating it to existing work would provide more context.

Reviewer B:
Specific software tools and standards are mentioned, but with some vagueness (e.g. no mention of CRAN or Shiny in the text, though the terminology clearly implies the R language).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.