Skip to content
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

JOSE Checklist #5

Open
22 tasks done
AlexanderJuestel opened this issue Apr 18, 2022 · 8 comments
Open
22 tasks done

JOSE Checklist #5

AlexanderJuestel opened this issue Apr 18, 2022 · 8 comments

Comments

@AlexanderJuestel
Copy link
Collaborator

AlexanderJuestel commented Apr 18, 2022

Review checklist

Conflict of interest

Code of Conduct

General checks

  • Repository: Is the source for this learning module available at the repository url?

  • License: Does the repository contain a plain-text LICENSE file with the contents of a standard license? (OSI-approved for code, Creative Commons for content)

  • Version: Does the release version given match the repository release (v0.5)?

  • Authorship: Has the submitting author (@AlexanderJuestel ) made visible contributions to the module? Does the full list of authors seem appropriate and complete?

Documentation

  • A statement of need: Do the authors clearly state the need for this module and who the target audience is?

  • Installation instructions: Is there a clearly stated list of dependencies?

  • Usage: Does the documentation explain how someone would adopt the module, and include examples of how to use it?

  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the module 2) Report issues or problems with the module 3) Seek support

Pedagogy / Instructional design (Work-in-progress: reviewers, please comment!)

  • Learning objectives: Does the module make the learning objectives plainly clear? (We don't require explicitly written learning objectives; only that they be evident from content and design.)

  • Content scope and length: Is the content substantial for learning a given topic? Is the length of the module appropriate?

  • Pedagogy: Does the module seem easy to follow? Does it observe guidance on cognitive load? (working memory limits of 7 +/- 2 chunks of information)

  • Content quality: Is the writing of good quality, concise, engaging? Are the code components well crafted? Does the module seem complete?

  • Instructional design: Is the instructional design deliberate and apparent? For example, exploit worked-example effects; effective multi-media use; low extraneous cognitive load.

JOSE paper

  • Authors: Does the paper.md file include a list of authors with their affiliations?

  • A statement of need: Does the paper clearly state the need for this module and who the target audience is?

  • Description: Does the paper describe the learning materials and sequence?

  • Does it describe how it has been used in the classroom or other settings, and how someone might adopt it?

  • Could someone else teach with this module, given the right expertise?

  • Does the paper tell the "story" of how the authors came to develop it, or what their expertise is?

  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

@AlexanderJuestel
Copy link
Collaborator Author

Repository: Is the source for this learning module available at the repository url?

The repository is available at the following URL: https://github.com/cgre-aachen/gemgis_data

@AlexanderJuestel
Copy link
Collaborator Author

License: Does the repository contain a plain-text LICENSE file with the contents of a standard license? (OSI-approved for code, Creative Commons for content)

The Licence can be found here: https://github.com/cgre-aachen/gemgis_data/blob/main/LICENSE

@AlexanderJuestel
Copy link
Collaborator Author

Version: Does the release version given match the repository release (v0.5)?

The release version will be v0.1 upon submitting the paper

@AlexanderJuestel
Copy link
Collaborator Author

Authorship: Has the submitting author (@AlexanderJuestel ) made visible contributions to the module? Does the full list of authors seem appropriate and complete?

Yes, @AlexanderJuestel has made visible contributions. The full list of authors include most of the GemPy and GemGIS authors

image

@AlexanderJuestel
Copy link
Collaborator Author

A statement of need: Do the authors clearly state the need for this module and who the target audience is?

Yes, need is stated to explore the subsurface and target audience are students people interested in Geomodeling.
image

@AlexanderJuestel
Copy link
Collaborator Author

AlexanderJuestel commented Apr 18, 2022

Installation instructions: Is there a clearly stated list of dependencies?

The data repository mainly depends on GemGIS and GemPy. Their installation and documentation are linked in the readme. The list of dependencies can also be found in the respective requirement files

image

@AlexanderJuestel
Copy link
Collaborator Author

Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the module 2) Report issues or problems with the module 3) Seek support

The link to the Contribution/Community Guidelines is here: https://github.com/cgre-aachen/gemgis_data/blob/main/CONTRIBUTING.md

@AlexanderJuestel
Copy link
Collaborator Author

Authors: Does the paper.md file include a list of authors with their affiliations?

Yes

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant