zephyr/doc/contribute/contribute.rst

.. _contribute:

Contributing to the Zephyr Project
##################################

As an open-source project, we welcome and encourage the community to submit
patches for code, documentation, tests, and more, directly to the project.

.. toctree::
   :maxdepth: 1

   contribute_guidelines.rst
   doc-guidelines.rst
doc: add CONTRIBUTING.rst to project repo and docs GitHub notices a CONTRIBUTING file in a repo's root and will automatically add a link to this file on the page when a contributor creates an Issue or opens a Pull Request. (Expectation is CONTRIBUTING will have information about how to contribute to the project, format code, test fixes, and submit patches. We also want to have this document accessible from our technical docs, and not duplicate the content, so add linkage to make this work. The zephyrproject github wiki article that contributed to this new CONTRIBUTING doc will be made into a reference to this new doc once this PR is approved and merged. Replaces PR #929 Jira: ZEP-2085 Signed-off-by: David B. Kinder <david.b.kinder@intel.com> 2017-07-28 08:04:04 +08:00			`.. _contribute:`

			`Contributing to the Zephyr Project`
			`##################################`

			`As an open-source project, we welcome and encourage the community to submit`
			`patches for code, documentation, tests, and more, directly to the project.`

			`.. toctree::`
			`:maxdepth: 1`

			`contribute_guidelines.rst`
doc: add doc writing guides w/common usages I've collected some of the common issues encountered with doc reviews into a new contributing document, and included use of the Zephyr-specific extension for generating code building examples. Updated conf.py and created an external list of substitutions making it easier to manage them without editing the sphinx conf file (and documented this). Tweaked the comments in the application.py extension python code to render better in the generated doc that extracts these comments (keeps the documentation in the python code too to ease maintenance when updates are made). Updated the sample template to mention use of this sphinx extension. fixes: #6831 fixes: #6811 Signed-off-by: David B. Kinder <david.b.kinder@intel.com> 2018-05-05 07:31:05 +08:00			`doc-guidelines.rst`