-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Optimize README.md for clarity and usage
- Loading branch information
Showing
1 changed file
with
25 additions
and
8 deletions.
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -1,18 +1,35 @@ | ||
| # Moodle development conventions | ||
| Help fast and reliable accurate Moodle plugin development for Moodle 5.0. | ||
| # Aider-Powered Moodle Plugin Development Conventions | ||
|
|
||
| These conventions help you develop high-quality, reliable Moodle plugins for Moodle 5.0 using Aider. They ensure your plugins adhere to Moodle's coding standards, promote best practices, and streamline the development process. | ||
|
|
||
| ## Purpose | ||
|
|
||
| These conventions ensure: | ||
| * Moodle plugins quality is better | ||
| * The Moodle coding and api standardss are met | ||
| * Anybody developing Moodle with Aider will save time | ||
|
|
||
| * **High-Quality Plugins:** By enforcing coding standards and best practices, these conventions help you create robust, maintainable, and secure Moodle plugins. | ||
| * **Moodle Standards Compliance:** Your plugins will adhere to Moodle's coding and API standards, ensuring compatibility and maintainability. | ||
| * **Faster Development:** By providing clear guidelines, these conventions help you leverage Aider to accelerate your Moodle plugin development. | ||
|
|
||
| ## Use Cases | ||
| * develop a new plugin and get started fast and let AIDER do the work | ||
|
|
||
| ## Usage | ||
| (I ll find out soon) | ||
| * **New Plugin Development:** Use these conventions when starting a new Moodle plugin project to ensure consistency and efficiency. | ||
| * **Aider Integration:** These conventions guide Aider in generating Moodle plugin code that adheres to best practices. | ||
| * **Accelerated Development:** These conventions are designed for developers who want to leverage Aider to speed up their Moodle plugin development while maintaining high standards. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| These conventions are designed to be used with Aider. When developing a Moodle plugin, Aider will use these conventions to generate code that adheres to Moodle's standards. | ||
|
|
||
| To get started: | ||
|
|
||
| 1. Ensure you have Aider set up and configured. | ||
| 2. Refer to the `CONVENTIONS.md` file for the specific coding and API standards. | ||
| 3. Use Aider to generate your Moodle plugin code, and it will automatically apply these conventions. | ||
|
|
||
| ## Contributing | ||
|
|
||
| If you would like to contribute to these conventions, please submit a pull request with your proposed changes. | ||
|
|
||
| ## License | ||
|
|
||
| GPL 3.0 |