OpenFreeEnergy / OpenFreeEnergy/openfe

add plotting cookbook to docs

Open
#999 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
331
Forks
56
Avg merge
3d 9h
Merged PRs (30d)
13

Description

Unsure if this should be a tutorial or cookbook, but having something in our docs to give users a starting point would be valuable.

Contributor guide

Open the contributing guide

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.

Research direction

No documentation file, plotting example, or test is named in the issue. First inspect the existing documentation structure and plotting-related material, then clarify whether the deliverable is a tutorial or cookbook and which user workflow it should cover; done means a focused starting-point guide is added in the project’s established docs format.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-visualization, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.