carpentries-incubator/fair-research-software

Issues

• Episode 5: Specify the `encoding` when reading in JSON file

  #114 opened 3 months ago by milanmlft
  2

• Consider adding parameterisation as a callout in testing episode

  #123 opened 3 months ago by kkh451
  0

• Check the answer to the exercise on environmental impact of running code on HPC systems

  #129 opened 3 months ago by anenadic
  0

• The "Add some comments to a code block" in 04-code-readability exercise refers to "old" bad code file bad-code.py

  #86 opened 3 months ago by kkh451
  0

• Dark-mode screenshots are hard to read

  #84 opened 3 months ago by kkh451
  1

• The version control episode does not cover how to generate a diff

  #85 opened 3 months ago by kkh451
  0

• The solution to "Writing Docstrings" in code readability does not use a google style docstring (needed in testing episode)

  #88 opened 3 months ago by kkh451
  0

• The "Create a function" exercise in 04-code-readability uses an old version of read_json_to_dataframe

  #87 opened 3 months ago by kkh451
  0

• The "bad" code is not refactored in the version control or the code readability episode

  #89 opened 3 months ago by kkh451
  1

• Bug-Fix narrative should reference the failing test from challenge 2 - Edge Cases

  #93 opened 3 months ago by kkh451
  1

• Add a callout about good folder structure - data, results, figures, docs, source code

  #104 opened 3 months ago by anenadic
  0

• Add default branch name to git setup?

  #107 opened 3 months ago by SJaffa
  2

• Code readability plot doesn't work after code tidying

  #109 opened 3 months ago by SJaffa
  0

• Avoid dashes in Python module names

  #115 opened 3 months ago by milanmlft
  1

• Missing instructions to install pandas and matplotlib

  #116 opened 3 months ago by anenadic
  1

• Make clear that documentation published to gh-pages is PUBLIC even if repository is PRIVATE

  #122 opened 3 months ago by kkh451
  0

• Consider adding "Code Headers" to the documentation episode

  #124 opened 3 months ago by kkh451
  0

• Add a callout on how to render and make available as website code documentation created with mkdocs

  #119 opened 3 months ago by anenadic
  0

• Target audience/prerequisite clarification

  #118 opened 3 months ago by anenadic
  1

• virtual environments are not addressed

  #103 opened 3 months ago by anenadic
  0

• Images in the "Understanding commit contents" exercise (03-version-control) are hard to read

  #83 opened 3 months ago by kkh451
  1

• Make sure we have the start code for each episode in the "bad code" repo

  #117 opened 3 months ago by anenadic
  0

• Add CITATION.cff

  #127 opened 3 months ago by anenadic
  1

• Addition of a CITATION.cff file is done in both the documentation and open collaboration episodes

  #90 opened 3 months ago by kkh451
  1

• The solution to the pull request exercise (07-open-collaboration) is missing

  #92 opened 3 months ago by kkh451
  0

• Fix Git overview diagram to show local and remote machines

  #102 opened 3 months ago by anenadic
  1

• Possible inconsistency in the discussion of the accessibility principle between Introduction and Tools Episodes

  #82 opened 3 months ago by kkh451
  2

• Add unzipping and inspecting data/code in episode 01 on FAIR software

  #46 opened 3 months ago by anenadic
  0

• Clarify Gerry's user profile

  #26 opened 3 months ago by anenadic
  0

• Add a lesson-level learning objective for ethical considerations around software/data

  #7 opened 3 months ago by anenadic
  0

• Add Code Refinery and FAIR RS assessment in references

  #48 opened 5 months ago by anenadic
  0

• Draft narrative with data

  #20 opened 5 months ago by anenadic
  0

• Add references from episode 02 to references list.

  #40 opened 5 months ago by anenadic
  0

• NeSC research support essentials link update

  #49 opened 5 months ago by anenadic
  1

• Create a canonical repository to contain all data and clean code

  #18 opened 6 months ago by anenadic
  1

• Put back further reading section to episode 01

  #41 opened 6 months ago by anenadic
  1

• Adjust the FAIR list in episode 01

  #29 opened 6 months ago by anenadic
  2

• Reshuffle episode order

  #16 opened 6 months ago by anenadic
  0

• Create setup page

  #19 opened 6 months ago by anenadic
  2

• Prepare messy code to start with

  #17 opened 6 months ago by anenadic
  1

• Include the diagram from the TTW project

  #27 opened 7 months ago by anenadic
  1

• Add a table on FAIR principles for data and research software

  #15 opened 8 months ago by anenadic
  0