docs/developer-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2019 YOUR-ORGANIZATION-NAME
   4
   5
   6 Developer-Guide
   7 ===============
   8
   9 .. contents::
  10    :depth: 3
  11    :local:
  12
  13 .. note:
  14 ..   * This section is used to describe what a contributor needs to know in order to work on the componenta
  15
  16 ..   * this should be very technical, aimed at people who want to help develop the components
  17
  18 ..   * this should be how the component does what it does, not a requirements document of what the component should do
  19
  20 ..   * this should contain what language(s) and frameworks are used, with versions
  21
  22 ..   * this should contain how to obtain the code, where to look at work items (Jira tickets), how to get started developing
  23
  24 ..   * This note must be removed after content has been added.
  25
  26
  27 Processes
  28 ---------
  29
  30
  31
  32 Actions
  33 -------
  34