OpenFreeEnergy / OpenFreeEnergy/openfe

Protocol modules renaming

Open
#1,785 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In #1769 we find that the original naming structure for protocols is inadequate. We should try to find a structure that makes sense to us and users for an OpenFE v2.0.

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

Start by reading issue #1769 and the discussion in this issue to understand why the current protocol naming structure is inadequate. Map the existing protocol modules and identify the proposed OpenFE v2.0 naming requirements. Done means the project has an agreed, documented module structure and a clear migration scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.