-
Notifications
You must be signed in to change notification settings - Fork 0
License
embecosm/dcEmb_docs
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Contributing — dcEmb v0.1.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/embecosm-theme.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Current Models" href="currentmodels.html" />
<link rel="prev" title="dcEmb" href="index.html" />
</head><body>
<div class="logo">
<a href="index.html">
<img src="_static/logo.png"
alt="Embecosm Logo" width="185" height="75"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="currentmodels.html" title="Current Models"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="dcEmb"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">dcEmb v0.1.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Contributing</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#bugs-and-error-reports">Bugs and Error Reports</a></li>
<li class="toctree-l2"><a class="reference internal" href="#making-contributions">Making Contributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#style-guide">Style Guide</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="currentmodels.html">Current Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="doxygen.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="howto.html">Building Your Own model</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="testingsuite.html">Testing Suite</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/contributing.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="contributing">
<span id="contribute"></span><h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
<p>This is free and open source software, and contributions are welcome.</p>
<section id="bugs-and-error-reports">
<h2>Bugs and Error Reports<a class="headerlink" href="#bugs-and-error-reports" title="Permalink to this headline">¶</a></h2>
<p>If you spot an error in the code, please open an
<a class="reference external" href="https://github.com/embecosm/dcEmb/issues">issue</a> in the dcEmb repository.</p>
</section>
<section id="making-contributions">
<h2>Making Contributions<a class="headerlink" href="#making-contributions" title="Permalink to this headline">¶</a></h2>
<p>If you have a contribution of your own to make to the code, please open a
<a class="reference external" href="https://github.com/embecosm/dcEmb/pulls">pull request</a>. Don’t forget to
<a class="reference external" href="https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue">link a pull request to an issue</a> if you are solving
one. We may ask you to make changes before we merge your pull request.</p>
</section>
<section id="style-guide">
<h2>Style Guide<a class="headerlink" href="#style-guide" title="Permalink to this headline">¶</a></h2>
<p>This project follows <a class="reference external" href="https://google.github.io/styleguide/cppguide.html">Google’s C++ style guide</a>. We provide a .clang-format file within the root
directory, which can be used to <a class="reference external" href="https://clang.llvm.org/docs/ClangFormat.html">automatically format your code</a> to comply with these
guidelines.</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="currentmodels.html" title="Current Models"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="dcEmb"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">dcEmb v0.1.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Contributing</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2022, William Jones.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.1.
</div>
</body>
</html>About
No description, website, or topics provided.
License
Contributing
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published