Skip to content

Updated instrructions.md file to make llm model understand in a bette…#1316

Open
AbhiramDhanvi wants to merge 1 commit intomofa-org:mainfrom
AbhiramDhanvi:Instructions-file-updated
Open

Updated instrructions.md file to make llm model understand in a bette…#1316
AbhiramDhanvi wants to merge 1 commit intomofa-org:mainfrom
AbhiramDhanvi:Instructions-file-updated

Conversation

@AbhiramDhanvi
Copy link

Updated instrructions.md file to make llm model understand in a better code in efficient and proper optimized manner and give output accurately .

🧹 CHECKLIST

✅ Code Quality

  • Code follows project standards (INSTRUCTIONS.md)
  • cargo fmt applied
  • cargo clippy has no warnings

✅ Testing

  • Tests added or updated
  • All tests pass (cargo test)

✅ Documentation

  • Public APIs documented
  • README/docs updated if needed

✅ Architecture Rules (MoFA)

  • No business logic in kernel
  • No trait redefinition in foundation
  • Correct layer usage (kernel/foundation/runtime)

✅ PR Quality

  • PR is small and focused
  • No unrelated changes
  • Clear commit messages (WHY + WHAT)

🚀 DEPLOYMENT NOTES (IF NEEDED)

Example:
Requires setting ENV variable MOFA_CACHE=true


🧩 NOTES FOR REVIEWERS

Example:
Please review error propagation logic in agent module.


💡 WHY THIS TEMPLATE IS IMPROVED

This version is:

  • ✅ Simplified language (easy for humans + AI)
  • ✅ Clear structure (WHAT / WHY / HOW)
  • ✅ Includes examples (LLM-friendly)
  • ✅ Avoids ambiguity
  • ✅ Enforces MoFA architecture rules
  • ✅ Encourages small, clean PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant