🧑‍💻 Joomla Academy Task: Developing and Sharing a Private Plugin Project

🎯 Overview

To do the task, you are required to write a Joomla plugin that automatically populates metadata fields for articles.
You will complete the work independently in your own private GitHub repository and share access with Joomla Academy mentors for review and feedback.

[!IMPORTANT]

🔒 Why Use a Private Repository?

Using a private GitHub repository allows you to:

• Collaborate securely with Joomla Academy mentors.
• Not allow other students to see how you are working on the solution.

✅ Instructions for Students

1. Create a Private GitHub Repository

• Go to GitHub and log in.
• Click the “New” button to create a new repository.
• Name the repository something relevant (e.g. joomla-plugin-autometa).
• Set the repository visibility to Private.
• Add a .gitignore (select PHP), and a README.md to describe your project.

2. Grant Access to Joomla Academy Mentors - to allow mentors to view your private code:

• Navigate to your repository on GitHub.
• Click the Settings tab.
• Select Collaborators and teams (or Manage access).
• Click Invite a collaborator.
• Enter the GitHub username(s) provided by your mentors.
• Assign Read and Write access so they can review and provide feedback via commits.
• Once they accept the invite, mentors will be able to view your repository.

3. Complete the Plugin Task

4. Document and Test Your Plugin

Your repository should include:

• A clear README.md explaining:

  • What your plugin does
  • How to install and test it
  • Any assumptions or limitations

• Clean, well-commented code

• Functional plugin packaging (e.g., XML manifest, PHP logic)

• Optional extras such as screenshots or screencasts

5. Notify the Mentors

[!IMPORTANT] Once your code is committed and access has been granted:
Send a message to the Joomla Academy team via the Discussions channel.

Include:

• A link to your private repository for the plugin
• Confirmation that they’ve been invited to your GitHub repository
• For anything you’d like them to review or provide feedback on - create an Issue on your own repository and add a link additonally.

When you have completed the task.

Please commit your code to a fresh repository in your account on GitHub.

[!TIP] We expect you to have only the files of the test task in this repository, and we can directly download it as an installable extension from GitHub via “Code” => “Download ZIP.”.

📚 Resources Joomla Plugin Development: https://docs.joomla.org/Plugin_Development

Joomla Event Reference: https://docs.joomla.org/Plugin/Events

GitHub: https://github.com/