OpenFreeEnergy / OpenFreeEnergy/openfe
expose contributing guide in docs
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 332
- Forks
- 56
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 13
Description
maybe we have a contribution guide as a dropdown and put all our developer docs there that might distract regular users? Link to gufe and the like.
Contributor guide
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
Review the existing documentation structure and any current contribution guide, then assess how a contribution-guide dropdown could separate developer docs from regular-user content. Done means the contribution guide and links such as gufe are exposed in the documentation without obscuring user-focused material.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100