Purpose
- This repository contains developer guidance and rules stored in the
.githubfolder. These files define mandatory practices, progress tracking, and project-specific conventions that must be followed before starting work.
Key files
- .github/copilot-instructions.md: primary execution guidelines and mandatory start phrase.
- .github/instructions/1-sap-cap-rules.md: backend (SAP CAP) rules and conventions.
- .github/instructions/2-sap-ui-rules.md: frontend (UI5) rules.
- .github/instructions/3-jest-test-rules.md: testing rules.
- .github/instructions/4-bruno.md: Bruno collection instructions.
How to use these instructions (quick guide)
- Read the
.githubfiles listed above before beginning any task. - Before starting work, comply with the primary requirement in copilot-instructions.md: state the confirmation phrase exactly as written: "YES, MY WISE SAP DEVELOPMENT MASTER".
- Use the repository's progress/todo system to plan and track work. Update the todo list at the start of each task and mark items completed when done.
- Follow the language-specific rules in the corresponding file (for example, use the SAP CAP rules for backend work and the UI5 rules for frontend work).
- Ask for permission before adding new top-level files or folders. If you need to change the rules in
.github, request approval first.
Notes and best practices
- Keep changes minimal and focused; the
.githubrules expect conservative edits and explicit approvals for policy changes. - If you are unsure which rules apply to a change, open an issue or ask the repository maintainer.
If anything is unclear, ask and we'll update this README to make the workflow explicit.
If .codegraph/ does not exist, run:
npm i -g @colbymchenry/codegraph
codegraph install --yes
codegraph init -iGenerated to summarize and clarify the guidance in the .github folder.