Elgato_dark/podman-desktop
1
0
Fork 0
mirror of https://github.com/podman-desktop/podman-desktop synced 2026-04-21 17:47:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

chore: update contributing guide to mention extensions

Browse source 
The contributing guide has an entry on extensions - but it is out of date, and buried
enough that I didn't find it on my first pass.

This creates a section to add some visibility (too high up? It felt like it should be
before contributing to Podman Desktop itself), along with a bit of text to mention
what you can do with extensions.

Part of #10715.

Signed-off-by: Tim deBoer <git@tdeboer.ca>
This commit is contained in:
Tim deBoer 2025-01-27 14:04:13 -05:00
parent cdb657097b
commit 585569c73f
1 changed files with 14 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTING.md
View file

@ -10,6 +10,7 @@ that we follow.
## Topics
- [Reporting Issues](#reporting-issues)
- [Providing Extensions](#providing-extensions)
- [Working On Issues](#working-on-issues)
- [Contributing](#contributing)
- [Continuous Integration](#continuous-integration)
@ -37,6 +38,19 @@ The easier it is for us to reproduce it, the faster it'll be fixed!
Please don't include any private/sensitive information in your issue!
## Providing Extensions
Some of the best features of Podman Desktop aren't even in this repository!
We've created an API so that the capabilities of Podman Desktop can be expanded
by installing [extensions](https://podman-desktop.io/extensions).
Extensions can add support for new container engines, command line tools,
Kubernetes providers, or add elements to the UI like actions, badges, or views.
You can create your own extension and contribute it to the catalog for
others to use.
See the [extension documentation](https://podman-desktop.io/docs/extensions) on our website for more information.
## Working On Issues
Often issues will be assigned to someone, to be worked on at a later time.
@ -409,12 +423,6 @@ If you're unsure where to add code (renderer, UI, extensions, plugins) see the b
> **_NOTE:_** Each `extension` folder is a separately packaged module. If there are any issues with loading, make sure your module is packaged correctly.
### Extensions
Podman Desktop is modularized into extensions for each 'Provider'. You can also create and add your own extension.
See our [extensions documentation](https://podman-desktop.io/docs/extensions) on our website for more information.
### UI colors
Colors in Podman Desktop are now managed by a [`color-registry.ts`](https://github.com/containers/podman-desktop/blob/main/packages/main/src/plugin/color-registry.ts) file in order to easily switch between light and dark mode.