docs/developer-guides.rst

   1 ..
   2 ..  Copyright (c) 2019 AT&T Intellectual Property.
   3 ..  Copyright (c) 2019 Nokia.
   4 ..
   5 ..  Licensed under the Creative Commons Attribution 4.0 International
   6 ..  Public License (the "License"); you may not use this file except
   7 ..  in compliance with the License. You may obtain a copy of the License at
   8 ..
   9 ..    https://creativecommons.org/licenses/by/4.0/
  10 ..
  11 ..  Unless required by applicable law or agreed to in writing, documentation
  12 ..  distributed under the License is distributed on an "AS IS" BASIS,
  13 ..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 ..
  15 ..  See the License for the specific language governing permissions and
  16 ..  limitations under the License.
  17 ..
  18
  19
  20 .. contents::
  21    :depth: 3
  22    :local:
  23
  24 Developer-Guides
  25 ==============
  26
  27
  28 .. note:
  29 ..   * This section is used to describe what a contributor needs to know in order to work on the componenta
  30
  31 ..   * this should be very technical, aimed at people who want to help develop the components
  32
  33 ..   * this should be how the component does what it does, not a requirements document of what the component should do
  34
  35 ..   * this should contain what language(s) and frameworks are used, with versions
  36
  37 ..   * this should contain how to obtain the code, where to look at work items (Jira tickets), how to get started developing
  38
  39 ..   * This note must be removed after content has been added.
  40
  41
  42 Processes
  43 ---------
  44
  45
  46
  47 Actions
  48 -------
  49