Contributing — OpenAIRE Guidelines documentation

<!DOCTYPE html>   <html class="no-js" lang="en" >  <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Contributing — OpenAIRE Guidelines documentation</title> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="top" title="OpenAIRE Guidelines documentation" href="index.html"/> <link rel="next" title="Editing the guidelines" href="contrib_editing.html"/> <link rel="prev" title="OpenAIRE Guidelines for CRIS Managers" href="cris/index.html"/> <script src="_static/js/modernizr.min.js"></script> </head> <body class="wy-body-for-nav" role="document"> <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"> OpenAIRE Guidelines </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="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="main navigation"> <p class="caption"><span class="caption-text">Current Guidelines</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="literature/index.html">OpenAIRE Guidelines for Literature, institutional, and thematic Repositories</a></li> <li class="toctree-l1"><a class="reference internal" href="data/index.html">OpenAIRE Guidelines for Data Archives</a></li> <li class="toctree-l1"><a class="reference internal" href="cris/index.html">OpenAIRE Guidelines for CRIS Managers</a></li> <li class="toctree-l1"><a class="reference external" href="http://software-guidelines.readthedocs.io/en/latest/">Draft OpenAIRE Guidelines for Software Repository Managers</a></li> <li class="toctree-l1"><a class="reference external" href="https://guidelines-other-products.readthedocs.io/en/latest/">Draft OpenAIRE Guidelines for Other Research Products</a></li> </ul> <p class="caption"><span class="caption-text">How to Contribute</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="#create-a-github-account">Create a GitHub account</a></li> <li class="toctree-l2"><a class="reference internal" href="#participate-in-the-discussion">Participate in the discussion</a></li> <li class="toctree-l2"><a class="reference internal" href="#editing-the-guidelines">Editing the guidelines</a><ul> <li class="toctree-l3"><a class="reference internal" href="contrib_editing.html">Editing the guidelines</a></li> <li class="toctree-l3"><a class="reference internal" href="contrib_editing.html#submitting-a-pull-request">Submitting a pull request</a></li> <li class="toctree-l3"><a class="reference internal" href="contrib_editing.html#discussing-the-pull-request">Discussing the pull request</a></li> <li class="toctree-l3"><a class="reference internal" href="contrib_editing.html#merging-the-pull-request">Merging the pull request</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#get-notified">Get notified</a></li> </ul> </li> </ul> <p class="caption"><span class="caption-text">Appendix</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="md_requirements_h2020_oa_guidelines.html">How the Horizon 2020 Open Access requirements are met</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="index.html">OpenAIRE Guidelines</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html">Docs</a> »</li> <li>Contributing</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/contributing.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <div class="section" id="contributing"> <span id="id1"></span><h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">露</a></h1> <p>The OpenAIRE guidelines can be viewed online on <a class="reference external" href="http://guidelines.openaire.eu">http://guidelines.openaire.eu</a>.</p> <div class="section" id="create-a-github-account"> <h2>Create a GitHub account<a class="headerlink" href="#create-a-github-account" title="Permalink to this headline">露</a></h2> <p>You will need a GitHub account to contribute to the OpenAIRE guidelines. It is free an easy - just go to <a class="reference external" href="https://github.com/join">https://github.com/join</a> and follow the instructions.</p> <p>Once you’ve got your GitHub account, ahead on over to the OpenAIRE Guidelines on GitHub <a class="reference external" href="https://github.com/openaire/guidelines">https://github.com/openaire/guidelines</a></p> <a class="reference internal image-reference" href="_images/join.png"><img alt="_images/join.png" class="align-center" src="_images/join.png" style="width: 418.0px; height: 284.0px;" /></a> </div> <div class="section" id="participate-in-the-discussion"> <h2>Participate in the discussion<a class="headerlink" href="#participate-in-the-discussion" title="Permalink to this headline">露</a></h2> <ul class="simple"> <li>Want to participate in our discussion? Join the ongoing conversation on our list of issues: <a class="reference external" href="https://github.com/openaire/guidelines/issues">https://github.com/openaire/guidelines/issues</a></li> <li>Have a question, feedback or problem? Simply go open a new issue on our GitHub repository: <a class="reference external" href="https://github.com/openaire/guidelines/issues/new">https://github.com/openaire/guidelines/issues/new</a>.</li> </ul> <p>You can also get to the “New issue” from the frontpage of our GitHub repository:</p> <a class="reference internal image-reference" href="_images/issues.png"><img alt="_images/issues.png" class="align-center" src="_images/issues.png" style="width: 1418.0px; height: 320.0px;" /></a> <p><strong>Styles</strong></p> <p>The description of issues can be styled using a syntax called Markdown. See more on how to create headings, bold and bullets on <a class="reference external" href="https://guides.github.com/features/mastering-markdown/">https://guides.github.com/features/mastering-markdown/</a>. You can even include images in the text, simply by dragging and dropping the image onto the issue description text area.</p> </div> <div class="section" id="editing-the-guidelines"> <h2>Editing the guidelines<a class="headerlink" href="#editing-the-guidelines" title="Permalink to this headline">露</a></h2> <p>Found a typo or want to revise major parts of the guidelines? Editing the guidelines can be done directly on GitHub. If this is the first time you are using GitHub, follow our guide here: <a class="reference internal" href="contrib_editing.html#contrib-editing"><span class="std std-ref">Editing the guidelines</span></a></p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="contrib_editing.html">Editing the guidelines</a></li> <li class="toctree-l1"><a class="reference internal" href="contrib_editing.html#submitting-a-pull-request">Submitting a pull request</a></li> <li class="toctree-l1"><a class="reference internal" href="contrib_editing.html#discussing-the-pull-request">Discussing the pull request</a></li> <li class="toctree-l1"><a class="reference internal" href="contrib_editing.html#merging-the-pull-request">Merging the pull request</a></li> </ul> </div> </div> <div class="section" id="get-notified"> <h2>Get notified<a class="headerlink" href="#get-notified" title="Permalink to this headline">露</a></h2> <p>Afraid you missed an update? GitHub allows you to easily keep updated with the latest changes using their notifications:</p> <ul class="simple"> <li><a class="reference external" href="https://github.com/openaire/guidelines/notifications">https://github.com/openaire/guidelines/notifications</a></li> </ul> </div> </div> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="contrib_editing.html" class="btn btn-neutral float-right" title="Editing the guidelines" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="cris/index.html" class="btn btn-neutral" title="OpenAIRE Guidelines for CRIS Managers" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> © Copyright 2015,2022, OpenAIRE. This work is licensed under Creative Commons Attribution 4.0 International. </p> </div> Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/js/theme.js"></script> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.StickyNav.enable(); }); </script> </body> </html>

CINXE.COM

Contributing — OpenAIRE Guidelines documentation