OpenFreeEnergy / OpenFreeEnergy/openfe
`plan-rbfe-network` overwrites existing files by default
Open
Nobody has claimed this yet.
cli
- Dominant language
- Python
- Stars
- 332
- Forks
- 56
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 13
Description
If you call plan-rbfe-network you can overwrite an existing output directory (including any existing networks and transformations within). Given users will often just use the default arguments (hence not passing -o), this can be quite dangerous.
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
Start at the plan-rbfe-network CLI entry point and trace how its default output directory is selected and prepared. Reproduce the command with an existing output directory, then establish the intended protection against overwriting existing networks and transformations; done when a regression test covers the default invocation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100