Skip to content

chore: Add documentation on how to update the plugin #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
froozeify wants to merge 2 commits into
base: main
Choose a base branch
from
+22 −0
Open

chore: Add documentation on how to update the plugin #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
734d9a4
chore: Add documentation on how to update the plugin
froozeify Dec 10, 2025
b872b7e
add to gitignore ide folders
froozeify Dec 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ vendor/
composer.lock
*.min.*
var
/.vscode/
/.idea/
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,23 @@ You can also provide a destination path (ie. if your `empty` directory is not in
* `{LNAME}` will be replaced byt the lowercased name,
* `{UNAME}` will be replaced by the uppercased name,
* `{YEAR}` will be replaced by the current year.

## Updating Your Plugin

To import the changes made to the _pluginsGLPI empty_ template into your project,
we recommend using [_template-sync_](https://github.com/coopTilleuls/template-sync):

1. Run the script to synchronize your project with the latest version of the skeleton:

<!-- markdownlint-disable MD013 -->

```console
curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- https://github.com/pluginsGLPI/empty
```

<!-- markdownlint-enable MD013 -->

2. Resolve conflicts, if any
3. Run `git cherry-pick --continue`

For more advanced options, refer to [the documentation of _template sync_](https://github.com/coopTilleuls/template-sync#template-sync).