WorldFishCenter / WorldFishCenter/FasaEngine
Add a "Limitations" section to the README
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Per 2026-05-26 review with Matthew: the app should be presented transparently with its known limits so users can apply their own judgement.
To cover:
- No feeding trials have validated formulated diets against a reference diet.
- No model for ingredient interactions, palatability, or physical pellet/extrusion properties (water content, durability).
- No batch-level testing for anti-nutritional factors or nutrient composition — the engine trusts the FICD/ASNS reference values.
- Toxin thresholds use literature values; small-scale millers cannot measure them per batch.
- Strain-level requirements (e.g. GIFT vs generic Nile Tilapia) are not differentiated.
Place near the top of the README, before "What's in this MVP."
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
Open the README and locate the "What's in this MVP" section. Add a nearby "Limitations" section covering each of the five listed limitations, preserving the factual scope from the issue. Done means the section appears before "What's in this MVP" and all listed limitations are represented clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100