mirror of
https://github.com/Karaka-Management/Developer-Guide.git
synced 2026-02-06 07:48:40 +00:00
Update README.md
This commit is contained in:
parent
77d1af501a
commit
b3d5810473
17
README.md
17
README.md
|
|
@ -1 +1,16 @@
|
||||||
# Introduction
|
# Introduction
|
||||||
|
|
||||||
|
This developer guides intention is to provide useful information
|
||||||
|
for developers to help you to understand the structure of the
|
||||||
|
application, important classes, workflows and standards for
|
||||||
|
code quality as well as code style. The intention is to provide
|
||||||
|
enough information to get a basic understanding of these
|
||||||
|
key elements for module developers, frontend developers or
|
||||||
|
developers working on the core application.
|
||||||
|
|
||||||
|
The guide is **not** explaining in detail how to use classes,
|
||||||
|
for this you can find the automatically generated code
|
||||||
|
documentation. All the provided information are very important
|
||||||
|
to ensure the quality of the published code and often are mandatory.
|
||||||
|
Not following these guides can cause security issues, worsen the
|
||||||
|
user experience or even cause malfunction.
|
||||||
Loading…
Reference in New Issue
Block a user