Further update instruction

This commit is contained in:
2026-01-09 09:46:39 +01:00
parent a704640ebc
commit 600198ec9a

View File

@@ -1,5 +1,20 @@
# Development instructions # Development instructions
- This is a personal project that will only ever be used by me. No public distribution is planned.
- The project is written in PHP and targets Dokuwiki.
- Follow general PHP best practices.
- Follow Dokuwiki coding conventions: https://www.dokuwiki.org/devel
- Do not use `phpunit` There are missing dependencies that make it fail. - Do not use `phpunit` There are missing dependencies that make it fail.
- Use `php -l <file>` to check for syntax errors. - Use `php -l <file>` to check for syntax errors.
- Consider The official documentation for writing dokuwiki plugins: https://www.dokuwiki.org/devel:plugins - Consider The official documentation for writing dokuwiki plugins: https://www.dokuwiki.org/devel:plugins
# General instructions
- This plugin is inteded to be used by me for many years to come
- That means maintainability is more important than cutting edge technologies
- Write code that is easy to understand and modify
- Favor stability over performance unless performance is a clear requirement
- Favor simplicity over cleverness
- Favor explicitness over implicitness
- Favor well-known solutions over new or exotic solutions
- Favor documented solutions over undocumented solutions
- Favor built-in solutions over external dependencies