| <!-- |
| Documentation/_templates/layout.html |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. The |
| ASF licenses this file to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance with the |
| License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| License for the specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en"> |
| <head> |
| <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>Contributing — NuttX latest documentation</title> |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/copybutton.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/sphinx_collapse.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/custom.css" /> |
| |
| |
| <link rel="shortcut icon" href="../_static/favicon.ico"/> |
| <script src="../_static/jquery.js"></script> |
| <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> |
| <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> |
| <script src="../_static/doctools.js"></script> |
| <script src="../_static/sphinx_highlight.js"></script> |
| <script src="../_static/clipboard.min.js"></script> |
| <script src="../_static/copybutton.js"></script> |
| <script src="../_static/design-tabs.js"></script> |
| <script src="../_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="Development Workflow" href="workflow.html" /> |
| <link rel="prev" title="Directory Structure" href="../quickstart/organization.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| <a href="../index.html" class="icon icon-home"> NuttX |
| |
| |
| |
| </a> |
| |
| <!-- this version selector is quite ugly, should be probably replaced by something |
| more modern --> |
| |
| <div class="version-selector"> |
| <select onchange="javascript:location.href = this.value;"> |
| |
| <option value="../../latest" selected="selected">latest</option> |
| |
| <option value="../../10.0.0" >10.0.0</option> |
| |
| <option value="../../10.0.1" >10.0.1</option> |
| |
| <option value="../../10.1.0" >10.1.0</option> |
| |
| <option value="../../10.2.0" >10.2.0</option> |
| |
| <option value="../../10.3.0" >10.3.0</option> |
| |
| <option value="../../11.0.0" >11.0.0</option> |
| |
| <option value="../../12.0.0" >12.0.0</option> |
| |
| <option value="../../12.1.0" >12.1.0</option> |
| |
| <option value="../../12.2.0" >12.2.0</option> |
| |
| <option value="../../12.2.1" >12.2.1</option> |
| |
| <option value="../../12.3.0" >12.3.0</option> |
| |
| <option value="../../12.4.0" >12.4.0</option> |
| |
| <option value="../../12.5.0" >12.5.0</option> |
| |
| <option value="../../12.5.1" >12.5.1</option> |
| |
| <option value="../../12.6.0" >12.6.0</option> |
| |
| <option value="../../12.7.0" >12.7.0</option> |
| |
| <option value="../../12.8.0" >12.8.0</option> |
| |
| <option value="../../12.9.0" >12.9.0</option> |
| |
| <option value="../../12.10.0" >12.10.0</option> |
| |
| <option value="../../12.11.0" >12.11.0</option> |
| |
| </select> |
| </div> |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <p class="caption" role="heading"><span class="caption-text">Table of Contents</span></p> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="workflow.html">Development Workflow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="making-changes.html">Making Changes Using Git</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="coding_style.html">C Coding Standard</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="documentation.html">Documentation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html">Creating an Apache NuttX Release</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../platforms/index.html">Supported Platforms</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../implementation/index.html">Implementation Details</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../reference/index.html">API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../debugging/index.html">Debugging</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../guides/index.html">Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../standards/index.html">Standards</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../logos/index.html">NuttX Logos</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../_tags/tagsindex.html">Tags</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../index.html">NuttX</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item active">Contributing</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="https://github.com/apache/nuttx/blob/master/Documentation/contributing/index.rst" class="fa fa-github"> Edit on GitHub</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="contributing"> |
| <h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this heading"></a></h1> |
| <p>In the following sections you will find important information on how to contribute |
| to NuttX codebase (from small bugfixes to large new features) and documentation |
| (the one you are reading now):</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="workflow.html">Development Workflow</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="making-changes.html">Making Changes Using Git</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="making-changes.html#git-workflow-with-an-upstream-repository">Git Workflow With an Upstream Repository</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="making-changes.html#submitting-your-changes-to-nuttx">Submitting Your Changes to NuttX</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="making-changes.html#how-to-include-the-suggestions-on-your-pull-request">How to Include the Suggestions on Your Pull Request?</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="making-changes.html#git-resources">Git Resources</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="coding_style.html">C Coding Standard</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="coding_style.html#quick-check-for-compliance">Quick Check for Compliance</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="coding_style.html#general-conventions">General Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="coding_style.html#data-and-type-definitions">Data and Type Definitions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="coding_style.html#functions">Functions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="coding_style.html#statements">Statements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="coding_style.html#c">C++</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="coding_style.html#using-pre-commit">Using Pre-Commit</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="coding_style.html#appendix">Appendix</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="documentation.html">Documentation</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="documentation.html#building">Building</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="documentation.html#contributing">Contributing</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="documentation.html#writing-restructure-text-with-sphinx">Writing ReStructure Text with Sphinx</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="documentation.html#documentation-conventions">Documentation Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="documentation.html#tips">Tips</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="releases.html">Creating an Apache NuttX Release</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html#checkout-the-distribution-svn-repositories">Checkout the distribution SVN repositories</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html#adding-your-gpg-key">Adding your GPG key</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html#add-your-gpg-key-to-github-apache">Add your GPG key to GitHub / Apache</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html#creating-a-release-candidate">Creating a Release Candidate</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html#creating-the-release-tarballs">Creating the Release Tarballs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html#check-the-release-artifacts">Check the release artifacts</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html#staging-the-release-candidate">Staging the release candidate</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html#call-for-a-community-vote">Call for a Community Vote</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html#staging-the-release">Staging the release</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html#create-release-tags">Create release tags</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html#create-a-pr-to-add-the-release-to-the-website">Create a PR to add the Release to the Website</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="releases.html#send-the-release-email-out">Send the release email out</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="../quickstart/organization.html" class="btn btn-neutral float-left" title="Directory Structure" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="workflow.html" class="btn btn-neutral float-right" title="Development Workflow" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2023, The Apache Software Foundation.</p> |
| </div> |
| |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
