Problem/Motivation

We want to make it easier for people to create new source plugins and should offer some help and guidance on how to do so.

Steps to reproduce

Try to create your own source plugin.

Proposed resolution

Add a readme file to the "Project Browser Devel" module as that has got the bare minimum skeleton to create a new plugin. Maybe adapt some comments and descriptions on that submodule to help users through the process.

Add a documentation page in the project's handbook.

Remaining tasks

  • ✅ File an issue about this project
  • ✅ Manual Testing
  • ☐ Code Review
  • ☐ Accessibility Review
  • ☐ Automated tests needed/written?

Issue fork project_browser-3310876

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

fjgarlin created an issue. See original summary.

fjgarlin opened merge request !251

fjgarlin’s picture

fjgarlin commented
Assigned: fjgarlin » Unassigned
Status: Active » Needs review

This is almost the bare minimum code to create a new plugin. It includes a README file as well as an optional .install file.
Please review the code and the commends.

chrisfromredfin made their first commit to this issue’s fork.

pontus.talvikarhu’s picture

pontus.talvikarhu commented
Issue summary: View changes
Status: Needs review » Reviewed & tested by the community

I went through the steps, read through the code and docs, and it works and is intuitive enough that I could create a source of my own based on this.

chrisfromredfin’s picture

chrisfromredfin
he/him/his
Primary language English
Location Portland, Maine
commented

Thank you, Pontus and thanks for your first contribution to Project Browser!

chrisfromredfin’s picture

chrisfromredfin
he/him/his
Primary language English
Location Portland, Maine
commented
Status: Reviewed & tested by the community » Fixed

This will help our developers greatly!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.