CONTRIBUTING.rst

   1 ..
   2       Licensed under the Apache License, Version 2.0 (the "License"); you may
   3       not use this file except in compliance with the License. You may obtain
   4       a copy of the License at
   5
   6           http://www.apache.org/licenses/LICENSE-2.0
   7
   8       Unless required by applicable law or agreed to in writing, software
   9       distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  10       WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  11       License for the specific language governing permissions and limitations
  12       under the License.
  13
  14       Convention for heading levels in Open vSwitch documentation:
  15
  16       =======  Heading 0 (reserved for the title in a document)
  17       -------  Heading 1
  18       ~~~~~~~  Heading 2
  19       +++++++  Heading 3
  20       '''''''  Heading 4
  21
  22       Avoid deeper levels because they do not render well.
  23
  24 ============================
  25 Contributing to Open vSwitch
  26 ============================
  27
  28 As an open source project, we welcome contributions of any kind. These can
  29 range from bug reports and code reviews, to signficant code or documentation
  30 features.
  31
  32 Extensive guidelines are provided in the docs at
  33 ``Documentation/internals/contributing``, or `online
  34 <http://docs.openvswitch.org/en/latest/internals/contributing/>`__.