| <!DOCTYPE html> |
| <html lang="en-us"> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta name="robots" content="all,follow"> |
| <meta name="googlebot" content="index,follow,snippet,archive"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <title>Contributing :: Eclipse Hono™</title> |
| <meta name="author" content="" /> |
| |
| |
| |
| |
| <meta name="description" content="A set of micro-services for connecting millions of devices."> |
| |
| |
| <meta name="generator" content="Hugo 0.58.3" /> |
| |
| <link href='//fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,500,700,800' rel='stylesheet' type='text/css'> |
| |
| |
| <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.8.2/css/all.css" integrity="sha384-oS3vJWv+0UjzBfQzYUhtDYW+Pj2yciDJxpsK1OYPAYjqT085Qq/1cq5FLXAZQ7Ay" crossorigin="anonymous"> |
| <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous"> |
| |
| |
| <link href="/hono/css/animate.css" rel="stylesheet"> |
| |
| |
| |
| <link href="/hono/css/style.hono.css" rel="stylesheet" id="theme-stylesheet"> |
| |
| |
| |
| |
| <link href="/hono/css/custom.css" rel="stylesheet"> |
| |
| |
| |
| <!--[if lt IE 9]> |
| <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> |
| <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> |
| <![endif]--> |
| |
| |
| |
| <link rel="apple-touch-icon" sizes="180x180" href="/hono/favicon/apple-touch-icon.png"> |
| <link rel="icon" type="image/png" sizes="48x48" href="/hono/favicon/favicon-48x48.png"> |
| <link rel="icon" type="image/png" sizes="32x32" href="/hono/favicon/favicon-32x32.png"> |
| <link rel="icon" type="image/png" sizes="16x16" href="/hono/favicon/favicon-16x16.png"> |
| <link rel="manifest" href="/hono/favicon/site.webmanifest"> |
| <link rel="mask-icon" href="/hono/favicon/safari-pinned-tab.svg" color="#5bbad5"> |
| <link rel="shortcut icon" href="/hono/favicon/favicon.ico"> |
| <meta name="msapplication-TileColor" content="#da532c"> |
| <meta name="msapplication-config" content="/hono/favicon/browserconfig.xml"> |
| <meta name="theme-color" content="#ffffff"> |
| |
| |
| |
| <link href="/hono/css/owl.carousel.css" rel="stylesheet"> |
| <link href="/hono/css/owl.theme.css" rel="stylesheet"> |
| |
| <link rel="alternate" href="https://www.eclipse.org/hono//index.xml" type="application/rss+xml" title="Eclipse Hono&trade;"> |
| |
| |
| <meta name="twitter:card" content="summary_large_image"> |
| <meta name="twitter:site" content="@EclipseHono"> |
| <meta name="twitter:title" content="Contributing :: Eclipse Hono&trade;"> |
| <meta name="twitter:image" content="https://www.eclipse.org/hono/img/twitter_image.png"> |
| <meta name="twitter:description" content="A set of micro-services for connecting millions of devices."> |
| |
| |
| <meta property="og:title" content="Contributing :: Eclipse Hono&trade;" /> |
| <meta property="og:type" content="website" /> |
| <meta property="og:url" content="https://www.eclipse.org/hono/community/contributing//" /> |
| <meta property="og:image" content="https://www.eclipse.org/hono/img/twitter_image.png" /> |
| |
| <link rel="stylesheet" href="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css"> |
| |
| </head> |
| |
| |
| <body> |
| |
| <div id="all"> |
| |
| <header> |
| |
| <div class="navbar-affixed-top" data-spy="affix" data-offset-top="70"> |
| |
| <div class="navbar navbar-default yamm" role="navigation" id="navbar"> |
| |
| <div class="container"> |
| <div class="navbar-header"> |
| <a class="navbar-brand home" href="https://www.eclipse.org/hono/"> |
| <img src="https://www.eclipse.org/hono/img/HONO-Logo_Bild-Wort_quer-s-310x120px.svg" alt="Contributing logo" class="logo"> |
| <span class="sr-only">Contributing - go to homepage</span> |
| </a> |
| <div class="navbar-buttons"> |
| <button type="button" class="navbar-toggle btn-template-main" data-toggle="collapse" data-target="#navigation"> |
| <span class="sr-only">Toggle Navigation</span> |
| <i class="fa fa-align-justify"></i> |
| </button> |
| </div> |
| </div> |
| |
| |
| <div class="navbar-collapse collapse" id="navigation"> |
| <ul class="nav navbar-nav navbar-right"> |
| |
| |
| |
| <li class="dropdown"> |
| |
| |
| |
| |
| <a href="/hono/getting-started/">Getting started</a> |
| |
| </li> |
| |
| |
| <li class="dropdown"> |
| |
| |
| |
| |
| <a href="/hono/docs/">Documentation</a> |
| |
| </li> |
| |
| |
| <li class="dropdown"> |
| |
| |
| |
| |
| <a href="/hono/downloads/">Download</a> |
| |
| </li> |
| |
| |
| <li class="dropdown"> |
| |
| |
| |
| |
| <a href="/hono/sandbox/">Sandbox</a> |
| |
| </li> |
| |
| |
| <li class="dropdown"> |
| |
| |
| |
| |
| <a href="/hono/faq/">FAQ</a> |
| |
| </li> |
| |
| |
| <li class="dropdown"> |
| |
| |
| |
| |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Community <span class="caret"></span></a> |
| <ul class="dropdown-menu"> |
| |
| <li><a href="/hono/community/contributing/">Contributing</a></li> |
| |
| <li><a href="/hono/community/presentations/">Resources</a></li> |
| |
| <li><a href="/hono/community/get-in-touch/">Get in Touch</a></li> |
| |
| <li><a href="/hono/community/road-map/">Road Map</a></li> |
| |
| </ul> |
| |
| </li> |
| |
| </ul> |
| </div> |
| |
| |
| <div class="collapse clearfix" id="search"> |
| |
| <form class="navbar-form" role="search"> |
| <div class="input-group"> |
| <input type="text" class="form-control" placeholder="Search"> |
| <span class="input-group-btn"> |
| |
| <button type="submit" class="btn btn-template-main"><i class="fa fa-search"></i></button> |
| |
| </span> |
| </div> |
| </form> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| |
| |
| |
| </header> |
| |
| <div id="heading-breadcrumbs"> |
| <div class="container"> |
| <div class="row"> |
| <div class="col-md-12"> |
| <h1>Contributing</h1> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="content"> |
| |
| |
| <div class="container"> |
| |
| <div class="row"> |
| |
| <div class="col-md-12"> |
| |
| <div> |
| <p>Thank you for considering to contribute to Eclipse Hono™. We really appreciate the time and effort you want to |
| spend helping to improve things around here. And help we can use :-)</p> |
| |
| <p>Here is a (non-exclusive, non-prioritized) list of things you might be able to help us with:</p> |
| |
| <ul> |
| <li>bug reports</li> |
| <li>bug fixes</li> |
| <li>improvements regarding code quality e.g. improving readability, performance, modularity etc.</li> |
| <li>documentation (Getting Started guide, Examples, Deployment instructions for cloud environments)</li> |
| <li>features (both ideas and code are welcome)</li> |
| </ul> |
| |
| <p>You might also want to take a look at our <a href="https://github.com/eclipse/hono/issues">GitHub Issues</a> page and see if you can help out with any of the issues listed. We have put a <a href="https://github.com/eclipse/hono/labels/help%20wanted">help wanted</a> label on those issues that we are particularly keen on receiving contributions for.</p> |
| |
| <h2 id="eclipse-contributor-agreement">Eclipse Contributor Agreement</h2> |
| |
| <p>Before your contribution can be accepted by the project team contributors must |
| electronically sign the Eclipse Contributor Agreement (ECA).</p> |
| |
| <ul> |
| <li><a href="http://www.eclipse.org/legal/ECA.php">http://www.eclipse.org/legal/ECA.php</a></li> |
| </ul> |
| |
| <p>Commits that are provided by non-committers must have a Signed-off-by field in |
| the footer indicating that the author is aware of the terms by which the |
| contribution has been provided to the project. The non-committer must |
| additionally have an Eclipse Foundation account and must have a signed Eclipse |
| Contributor Agreement (ECA) on file.</p> |
| |
| <p>For more information, please see the Eclipse Committer Handbook: |
| <a href="https://www.eclipse.org/projects/handbook/#resources-commit">https://www.eclipse.org/projects/handbook/#resources-commit</a></p> |
| |
| <h2 id="conventions">Conventions</h2> |
| |
| <ol> |
| <li>The <em>groupId</em> of all Hono modules is <code>org.eclipse.hono</code>, <em>artifactId</em> always starts with <code>hono-</code>.</li> |
| <li>Modules producing a Docker image generally use <code>eclipse/${artifactId}</code> as the image’s repository name.</li> |
| <li>All code complies with the formatting rules defined by the settings files in the <code>eclipse</code> folder.</li> |
| <li>Modules implementing one of the Hono APIs are sub-modules of <code>services</code>.</li> |
| </ol> |
| |
| <h2 id="making-your-changes">Making your Changes</h2> |
| |
| <ol> |
| <li><a href="https://github.com/eclipse/hono#fork-destination-box">Fork the repository on GitHub</a>.</li> |
| <li>Create a new <em>feature branch</em> for your changes.</li> |
| <li>Make your changes.</li> |
| <li>Make sure your code complies with the formatting rules defined by the settings files in the <code>eclipse</code> folder.</li> |
| |
| <li><p>If you are creating new class files, make sure that they include a <a href="https://www.eclipse.org/projects/handbook/#ip-copyright-headers">proper copyright header</a> at the top. |
| Any new file created should contain a header based on the following template:</p> |
| |
| <pre><code>/** |
| * Copyright (c) {year} Contributors to the Eclipse Foundation |
| * |
| * See the NOTICE file(s) distributed with this work for additional |
| * information regarding copyright ownership. |
| * |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License 2.0 which is available at |
| * https://www.eclipse.org/legal/epl-2.0 |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| */ |
| </code></pre></li> |
| |
| <li><p>Do not forget to add yourself or your organization to the copyright holder list in the NOTICE file in the parent folder if you haven’t already done so in a previous contribution.</p></li> |
| |
| <li><p>Make sure you include test cases for non-trivial features.</p></li> |
| |
| <li><p>Make sure the test suite passes after your changes.</p></li> |
| |
| <li><p>Commit your changes into your <em>feature branch</em>.</p></li> |
| |
| <li><p>Use descriptive and meaningful commit messages.</p></li> |
| |
| <li><p>Squash multiple commits related to the same feature/issue into a single one, if reasonable.</p></li> |
| |
| <li><p>Make sure you use the <code>-s</code> flag when committing in order to add a <em>Signed-off-by</em> footer as mentioned above.</p></li> |
| |
| <li><p>Push your changes to your branch in your forked repository.</p></li> |
| </ol> |
| |
| <h2 id="submitting-the-changes">Submitting the Changes</h2> |
| |
| <p>Submit a pull request via the GitHub UI.</p> |
| |
| <h2 id="after-submitting">After Submitting</h2> |
| |
| <p>Do not use your <em>feature branch</em> for any other development, otherwise further changes that you make will be visible in the PR.</p> |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| |
| |
| |
| </div> |
| |
| |
| <footer id="footer"> |
| <div class="container"> |
| |
| <div class="col-md-4 col-sm-6"> |
| <h4>More</h4> |
| |
| <ul> |
| <li><a href="https://github.com/eclipse/hono" title="View Source Code on GitHub"><i class='fab fa-github'></i> GitHub Repository</a></li> |
| <li><a href="https://twitter.com/EclipseHono" title="Follow us on Twitter"><i class='fab fa-twitter'></i> Twitter</a></li> |
| <li><a href="https://gitter.im/eclipse/hono" title="Chat with us on Gitter"><i class='fab fa-gitter'></i> Chat with us</a></li> |
| <li><a href="/hono/thankyou/">Thank you</a></li> |
| </ul> |
| |
| <hr class="hidden-md hidden-lg hidden-sm"> |
| |
| </div> |
| |
| |
| <div class="col-md-4 col-sm-6"> |
| |
| <h4>Eclipse Legal</h4> |
| |
| <ul> |
| <li><a href="http://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a></li> |
| <li><a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a></li> |
| <li><a href="http://www.eclipse.org/legal/copyright.php" target="_blank">Copyright Agent</a></li> |
| <li><a href="http://www.eclipse.org/legal/" target="_blank">Legal</a></li> |
| <li><a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank">License</a></li> |
| <li><a href="https://eclipse.org/security/" target="_blank">Report a Vulnerability</a></li> |
| </ul> |
| |
| <hr class="hidden-md hidden-lg"> |
| |
| </div> |
| |
| |
| <div class="col-md-4 col-sm-6"> |
| |
| <div class="eclipse-logos"> |
| <div class="pull-left"> |
| <a href="https://www.eclipse.org" target="_blank"> |
| <img src="https://www.eclipse.org/hono/img/eclipse_foundation_logo_wo.svg" id="logo-eclipse-foundation"/> |
| </a> |
| </div> |
| <div class="pull-right"> |
| <a href="https://iot.eclipse.org" target="_blank"> |
| <img src="https://www.eclipse.org/hono/img/iot-logo.png"/> |
| </a> |
| </div> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| |
| </footer> |
| |
| |
| |
| |
| |
| |
| |
| <div id="copyright"> |
| <div class="container"> |
| <div class="col-md-12"> |
| |
| <p class="pull-left">© 2019 The Eclipse Hono Project</p> |
| |
| <p class="pull-right"> |
| Template by <a href="http://bootstrapious.com/free-templates">Bootstrapious</a>. |
| |
| |
| Ported to Hugo by <a href="https://github.com/devcows/hugo-universal-theme">DevCows</a> |
| </p> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| <script src="//code.jquery.com/jquery-3.1.1.min.js" integrity="sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8=" crossorigin="anonymous"></script> |
| <script src="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script> |
| |
| <script src="//cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script> |
| <script src="//cdnjs.cloudflare.com/ajax/libs/waypoints/4.0.1/jquery.waypoints.min.js"></script> |
| <script src="//cdnjs.cloudflare.com/ajax/libs/Counter-Up/1.0/jquery.counterup.min.js"></script> |
| <script src="//cdnjs.cloudflare.com/ajax/libs/jquery-parallax/1.1.3/jquery-parallax.js"></script> |
| |
| |
| |
| |
| |
| <script src="https://www.eclipse.org/hono/js/front.js"></script> |
| |
| |
| <script src="https://www.eclipse.org/hono/js/owl.carousel.min.js"></script> |
| |
| |
| |
| <script> |
| (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': |
| new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], |
| j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= |
| 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); |
| })(window,document,'script','dataLayer','GTM-5WLCZXC'); |
| </script> |
| |
| |
| <script src="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script> |
| |
| <script src="//iot.eclipse.org/assets/js/eclipsefdn.adopters.js"></script> |
| <script> |
| eclipseFdnAdopters.getList({ |
| project_id: "iot.hono", |
| selector: ".eclipsefdn-adopters", |
| ul_classes: "owl-carousel customers", |
| logo_white: true |
| }); |
| </script> |
| |
| |
| </body> |
| </html> |
