Skip to content

Commit f8fad5c

Browse files
committed
Note about project_files and global_files
1 parent 4fc4606 commit f8fad5c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/content/blog/ddev-add-on-maintenance-guide.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,15 @@ Maintaining a DDEV add-on is more than a one-time task. As DDEV evolves, so shou
1919

2020
Here are some high-level practices to follow:
2121

22+
- Take inspiration from the [official add-ons](https://addons.ddev.com/), see how they're structured and follow similar practices
2223
- Keep an eye on updates in [ddev-addon-template](https://github.com./ddev/ddev-addon-template)
2324
- Track changes in [DDEV releases](https://github.com./ddev/ddev/releases)
2425
- Configure your add-on [repository settings](#repository-configuration-bestpractices)
2526
- Remember to publish a new release after any update (unless it's just a `README.md` change)
2627
- 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.
2728
- 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.
2830
- 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
3031

3132
## What's New in the DDEV Ecosystem
3233

@@ -69,7 +70,7 @@ This ensures compatibility and resolves known issues, such as those related to t
6970
7071
### Add-on Badges
7172
72-
The old `maintained` badge required yearly updates, which became a maintenance burdenespecially 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.
7374

7475
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).
7576

0 commit comments

Comments
 (0)