Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add README files to all data clarifying provenance and status

Open
#49 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
jupyter-notebook
Domain
data, documentation

Research direction

Start by inventorying the data directories and identifying the tyk2 inputs, PLB inputs, and internal benchmark inputs mentioned in the issue. Add a README for each data area that records provenance and current status, with completion meaning users can distinguish synchronized inputs from standalone examples.

Written by the indexing model from the issue text.

Description

We need to make sure that folks don't suddenly feel like using say the tyk2 inputs and assuming that they are synched with the PLB or even our own internal benchmark inputs.

Dominant language
Jupyter Notebook
Stars
70
Forks
15
Avg merge
4d 11h
Merged PRs (30d)
4

Getting set up

We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenFreeEnergy/ExampleNotebooks

All issues in OpenFreeEnergy/ExampleNotebooks

Similar issues

More Data Engineering issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.