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

Update READMEs

Open
  • Is something wrong?
#48 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
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
jupyter-notebook
Domain
documentation

Research direction

Start with the main README and the existing secondary README files alongside the notebooks. Update the main README and ensure each secondary README explains why its notebook exists, with the work done when both the overview and notebook-specific purposes are documented.

Written by the indexing model from the issue text.

Description

The main readme needs to be updated, and we need secondary readmes to explain why a notebook exists (in addition to explanation in the notebook itself).

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 Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.