You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/blog/ddev-add-on-maintenance-guide.md
+3-2
Original file line number
Diff line number
Diff line change
@@ -19,14 +19,15 @@ Maintaining a DDEV add-on is more than a one-time task. As DDEV evolves, so shou
19
19
20
20
Here are some high-level practices to follow:
21
21
22
+
- Take inspiration from the [official add-ons](https://addons.ddev.com/), see how they're structured and follow similar practices
22
23
- Keep an eye on updates in [ddev-addon-template](https://github.com./ddev/ddev-addon-template)
23
24
- Track changes in [DDEV releases](https://github.com./ddev/ddev/releases)
24
25
- Configure your add-on [repository settings](#repository-configuration-bestpractices)
25
26
- Remember to publish a new release after any update (unless it's just a `README.md` change)
26
27
- Add the `ddev-get`[topic](https://docs.github.com./en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics) to your GitHub repository.
27
28
- Write a clear [description](https://github.com./orgs/community/discussions/60507) and include relevant keywords to improve discoverability in the [DDEV Add-on Registry](https://addons.ddev.com)
29
+
- Ensure your add-on cleans up after itself: both `ddev add-on get` and `ddev add-on remove` should be idempotent. All files added via `project_files` and `global_files` must include a `#ddev-generated` stanza to support proper removal.
28
30
- Regularly update your add-on to ensure compatibility and take advantage of new features
29
-
- Take inspiration from the [official add-ons](https://addons.ddev.com/addons/ddev/) — see how they're structured and follow similar practices
30
31
31
32
## What's New in the DDEV Ecosystem
32
33
@@ -69,7 +70,7 @@ This ensures compatibility and resolves known issues, such as those related to t
69
70
70
71
### Add-on Badges
71
72
72
-
The old `maintained` badge required yearly updates, which became a maintenance burden—especially for contributors with many add-ons. It's now replaced by a `last commit` badge.
73
+
The old `maintained` badge required yearly updates, which became a maintenance burden, especially for contributors with many add-ons. It's now replaced by a `last commit` badge.
73
74
74
75
To improve visibility and engagement on the [DDEV Add-on Registry](https://addons.ddev.com), add the registry badge to your [README.md](https://github.com./ddev/ddev-addon-template).
0 commit comments