OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
Update READMEs
Open
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 70
- Forks
- 15
- Avg merge
- 10h 42m
- Merged PRs (30d)
- 2
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).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100