-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Add Moodle instructions #743
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bhect0
wants to merge
2
commits into
github:main
Choose a base branch
from
bhect0:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+58
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| applyTo: '**/*.php, **/*.js, **/*.mustache, **/*.xml, **/*.css, **/*.scss' | ||
| description: 'Instructions for GitHub Copilot to generate code in a Moodle project context.' | ||
| --- | ||
|
|
||
| # Project Context | ||
|
|
||
| This repository contains a Moodle project. Ensure that any generated code is compatible with the specific Moodle version used in this project (for example, Moodle 3.11, 4.1 LTS, or later). | ||
|
|
||
| It includes: | ||
| - Plugin development (local, block, mod, auth, enrol, tool, etc.) | ||
| - Theme customization | ||
| - CLI scripts | ||
| - Integrations with external services using the Moodle API | ||
|
|
||
| # Code Standards | ||
|
|
||
| - Follow the official Moodle Coding guidelines: https://moodledev.io/general/development/policies/codingstyle | ||
| - PHP must be compatible with the core version (e.g., PHP 7.4 / 8.0 / 8.1). | ||
| - Do not use modern syntax that is not supported by core if it breaks compatibility. | ||
| - Class naming must use Moodle namespaces. | ||
| - Follow Moodle’s standard plugin directory layout (for example: classes/output, classes/form, db/, lang/, templates/…). | ||
| - Mandatory use of Moodle security functions: | ||
| - `$DB` with SQL placeholders | ||
| - `require_login()`, `require_capability()` | ||
| - Parameters handled with `required_param()` / `optional_param()` | ||
|
|
||
| # Code Generation Rules | ||
|
|
||
| - When creating new PHP classes in plugins, use the Moodle component (Frankenstyle) namespace that matches the plugin's component name, e.g. `local_myplugin`, `mod_forum`, `block_mycatalog`, `tool_mytool`. | ||
| - In plugins, always respect the structure: | ||
| - /db | ||
| - /lang | ||
| - /classes | ||
| - /templates | ||
| - /version.php | ||
| - /settings.php | ||
| - /lib.php (only if necessary) | ||
|
|
||
| - Use renderers and Mustache templates for HTML. Do not mix HTML inside PHP. | ||
| - In JavaScript code, use AMD modules, not inline scripts. | ||
| - Prefer Moodle API functions over manual code whenever possible. | ||
| - Do not invent Moodle functions that do not exist. | ||
|
|
||
| # Examples of What Copilot Should Be Able to Answer | ||
|
|
||
| - "Generate a basic local plugin with version.php, settings.php, and lib.php." | ||
| - "Create a new table in db/install.xml and an upgrade script in db/upgrade.php." | ||
| - "Generate a Moodle form using moodleform." | ||
| - "Create a renderer with Mustache to display a table." | ||
|
|
||
| # Expected Style | ||
|
|
||
| - Clear and specific answers in the Moodle context. | ||
| - Always include files with full paths. | ||
| - If there are multiple ways to do something, use the approach recommended by Moodle. | ||
|
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with all the tips. I submitted a commit that addresses all of the points :)