doc/Readme.md

   1 # Developer guide
   2
   3 Tuleap is a Free and Open Source software developed since 2001 under
   4 GPLv2 license. Contributions are welcomed, on Tuleap Core, on plugins,
   5 in documentation, etc.
   6
   7 Development of a Tuleap extension, outside of the main development tree
   8 is hard and you are likely to shoot yourself in the foot if you do so.
   9 The main reason is that Tuleap internal API is not guaranteed, it can
  10 change at any moment for any reasons.
  11
  12 REST API & Webhooks, on the other hand are very carefully maintained and
  13 we ensure, as much as possible the backward compatibility. We (the core
  14 team) strongly recommend to look this way for your developments.
  15
  16 This guide will gives you the insights to start your contributions to
  17 Tuleap:
  18
  19 -   Setting up your environment
  20 -   Push your code for review to integrators
  21 -   Understand Tuleap internals
  22
  23 You can also find help for your dev related questions on the [chat in
  24 the #general channel](https://chat.tuleap.org/).
  25
  26 ## Disclaimer
  27
  28 Documentation of a living tool is hard to achieve and, in case of
  29 doubts, the source code is always the reference.
  30
  31 When working with sources, you must look closely to [Architecture
  32 Decision
  33 Records](../adr/index.md)
  34 that will give insights on the evolutions of the code base and what is
  35 expected / current norm.
  36
  37 ## Getting started
  38
  39 Getting started, what you need to know to setup your environment and
  40 push your code
  41
  42 * [Contrib](contrib.md)
  43 * [Quick start](quick-start.md)
  44 * [Patches](patches.md)
  45 * [Coding standards](coding-standards.md)
  46 * [Expected code](expected-code.md)
  47 * [Development tools](development-tools.md)
  48
  49 Development 101, what you need to know
  50
  51 * [Front end](./front-end.md)
  52 * [Back end](./back-end.md)
  53 * [Tests](./tests.md)
  54 * [Internationalization](./internationalization.md)
  55 * [Integrators](./integrators.md)
  56
  57 Advanced topics
  58
  59 * [Release](./release.md)
  60 * [LDAP](./ldap.md)
  61 * [Realtime](./realtime.md)
  62 * [Trackers](./trackers.md)
  63 * [Gerrit](./gerrit.md)
  64 * [Project background](./project-background.md)
  65 * [Gitlab](./gitlab.md)
  66 * [Untrusted code execution](./untrusted-code-exec.md)