documentation/community/contributing.html - felix-site-pub - Git at Google

 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <title>Contributing :: Apache Felix</title>
     <link rel="canonical" href="https://felix.apache.org/documentation/community/contributing.html">
     <meta name="generator" content="Antora 2.3.4">
     <link rel="stylesheet" href="../../_/css/site.css">
     <link rel="icon" href="../../_/img/favicon.png" type="image/x-icon">
   </head>
   <body class="article">
 <header class="header">
   <nav class="navbar">
     <div class="navbar-brand">
       <a class="navbar-item" href="https://felix.apache.org/index.html">
         <span>
           <img src="../../_/img/logo.png">
         </span>
       </a>
       <button class="navbar-burger" data-target="topbar-nav">
         <span></span>
         <span></span>
         <span></span>
       </button>
     </div>
     <div id="topbar-nav" class="navbar-menu">
       <div class="navbar-end">
         <a class="navbar-item" href="https://felix.apache.org/index.html">Home</a>
         <div class="navbar-item has-dropdown is-hoverable">
           <a class="navbar-link" href="#">Subprojects</a>
           <div class="navbar-dropdown">
             <a class="navbar-item" href="../subprojects/apache-felix-dependency-manager.html">Dependency Manager</a>
             <a class="navbar-item" href="../subprojects/apache-felix-event-admin.html">Event Admin</a>
             <a class="navbar-item" href="../subprojects/apache-felix-file-install.html">File Install</a>
             <a class="navbar-item" href="../subprojects/apache-felix-framework.html">Framework</a>
             <a class="navbar-item" href="../subprojects/apache-felix-gogo.html">Gogo Shell</a>
             <a class="navbar-item" href="../subprojects/apache-felix-healthchecks.html">Health Checks</a>
             <a class="navbar-item" href="../subprojects/apache-felix-inventory.html">Inventory</a>
             <a class="navbar-item" href="../subprojects/apache-felix-log.html">Log</a>
             <a class="navbar-item" href="../subprojects/apache-felix-logback.html">Logback</a>
             <a class="navbar-item" href="../subprojects/apache-felix-maven-bundle-plugin.html">Maven bundle plugin</a>
             <a class="navbar-item" href="../subprojects/apache-felix-maven-scr-plugin.html">Maven SCR plugin</a>
             <a class="navbar-item" href="../subprojects/apache-felix-metatype-service.html">Metatype Service</a>
             <a class="navbar-item" href="../subprojects/apache-felix-preferences-service.html">Preferences Service</a>
             <a class="navbar-item" href="../subprojects/apache-felix-remote-shell.html">Remote Shell</a>
             <a class="navbar-item" href="../subprojects/apache-felix-script-console-plugin.html">Script console plugin</a>
             <a class="navbar-item" href="../subprojects/apache-felix-shell.html">Lightweight shell</a>
             <a class="navbar-item" href="../subprojects/apache-felix-shell-tui.html">Shell TUI</a>
             <a class="navbar-item" href="../subprojects/apache-felix-web-console.html">Web Console</a>
           </div>
         </div>
         <div class="navbar-item">
           <span class="control">
             <a class="button is-primary" href="../downloads.html">Downloads</a>
           </span>
         </div>
       </div>
     </div>
   </nav>
 </header>
 <div class="body">
 <div class="nav-container" data-component="documentation" data-version="master">
   <aside class="nav">
     <div class="panels">
 <div class="nav-panel-menu is-active" data-panel="menu">
   <nav class="nav-menu">
     <h3 class="title"><a href="../index.html">Documentation</a></h3>
 <ul class="nav-list">
   <li class="nav-item" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../documentation.html">Documentation</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../downloads.html">Downloads</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../getting-started.html">Getting Started</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../news.html">News</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Community</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="project-info.html">Apache Felix Project Info</a>
   </li>
   <li class="nav-item is-current-page" data-depth="2">
     <a class="nav-link" href="contributing.html">Contributing</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="projects-using-felix.html">Projects Using Felix</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Development</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../development/coding-standards.html">Coding Standards</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../development/dependencies-file-template.html">DEPENDENCIES file template</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../development/provisional-osgi-api-policy.html">Provisional OSGi API Policy</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../development/release-management-nexus.html">Release Management</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../development/site-how-to.html">Site How To</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../development/using-the-osgi-compliance-tests.html">Using the OSGi Compliance Tests</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../faqs.html">FAQS</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../faqs/apache-felix-bundle-plugin-faq.html">Apache Felix Bundle Plugin Frequently Asked Questions</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../faqs/apache-felix-scr-plugin-faq.html">Apache Felix SCR Plugin Frequently Asked Questions</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../subprojects.html">Subprojects</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager.html">Apache Felix Dependency Manager</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Guides</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/migrating-from-earlier-versions.html">Apache Felix Dependency Manager - Migrating from earlier versions</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/annotations.html">Dependency Manager - Annotations</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/background.html">Dependency Manager - Background</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/bundles-and-dependencies.html">Dependency Manager - Bundles and Dependencies</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/design-patterns.html">Dependency Manager - Design Patterns</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/development.html">Dependency Manager - Development</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/history.html">Dependency Manager - History</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/javadocs.html">Dependency Manager - JavaDocs</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/migrating-from-other-solutions.html">Dependency Manager - Migrating from other solutions.</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/performance-tuning.html">Dependency Manager - Performance Tuning</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/resources.html">Dependency Manager - Resource adapters</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/whatsnew.html">Dependency Manager - What&#8217;s new in version 4?</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/dm-lambda.html">Dependency Manager Lambda</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/guides/whatsnew-r15.html">What&#8217;s New in R15</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="3">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Reference</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/component-adapter.html">Dependency Manager - Adapter</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/component-aspect.html">Dependency Manager - Aspect</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/component-bundle-adapter.html">Dependency Manager - Bundle Adapter</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/dependency-bundle.html">Dependency Manager - Bundle Dependency</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/components.html">Dependency Manager - Components</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/dependency-configuration.html">Dependency Manager - Configuration Dependency</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/dependencies.html">Dependency Manager - Dependencies</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/external-links.html">Dependency Manager - External Links</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/component-factory-configuration-adapter.html">Dependency Manager - Factory Configuration Adapter Service</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/component-resource-adapter.html">Dependency Manager - Resource Adapter</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/dependency-resource.html">Dependency Manager - Resource Dependency</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/dependency-service.html">Dependency Manager - Service Dependency</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/service-scopes.html">Dependency Manager - Service Scopes</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/component-singleton.html">Dependency Manager - Singleton Component</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/thread-model.html">Dependency Manager - Thread Model</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/reference/dm-annotations.html">Dependency Manager Annotations</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="3">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Tutorials</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/tutorials/working-with-annotations.html">Dependency Manager - Annotations</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/tutorials/getting-started.html">Dependency Manager - Getting Started</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/tutorials/leveraging-the-shell.html">Dependency Manager - Leveraging the shell</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-dependency-manager/tutorials/sample-code.html">Dependency Manager sample projects</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-event-admin.html">Apache Felix Event Admin</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-file-install.html">Apache Felix File Install</a>
   </li>
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../subprojects/apache-felix-framework.html">Apache Felix Framework</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../subprojects/apache-felix-framework/apache-felix-framework-bundle-cache.html">Apache Felix Framework Bundle Cache</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../subprojects/apache-felix-framework/apache-felix-framework-configuration-properties.html">Apache Felix Framework Configuration Properties</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../subprojects/apache-felix-framework/apache-felix-framework-faq.html">Apache Felix Framework Frequently Asked Questions</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../subprojects/apache-felix-framework/apache-felix-framework-launching-and-embedding.html">Apache Felix Framework Launching and Embedding</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../subprojects/apache-felix-framework/apache-felix-framework-usage-documentation.html">Apache Felix Framework Usage Documentation</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-framework-security.html">Apache Felix Framework Security</a>
   </li>
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../subprojects/apache-felix-gogo.html">Apache Felix Gogo</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../subprojects/apache-felix-gogo/rfc-147-overview.html">RFC 147 Overview</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-healthchecks.html">Apache Felix Health Checks</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-inventory.html">Apache Felix Inventory Printer</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-log.html">Apache Felix Log</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-logback.html">Apache Felix Logback</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-maven-bundle-plugin-bnd.html">Apache Felix Maven Bundle Plugin (BND)</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-metatype-service.html">Apache Felix Metatype Service</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-osgi-bundle-repository.html">Apache Felix OSGi Bundle Repository (OBR)</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-preferences-service.html">Apache Felix Preferences Service</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-remote-shell.html">Apache Felix Remote Shell</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-shell.html">Apache Felix Shell</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../subprojects/apache-felix-shell-tui.html">Apache Felix Shell TUI</a>
   </li>
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../subprojects/apache-felix-web-console.html">Apache Felix Web Console</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../subprojects/apache-felix-web-console/extending-the-apache-felix-web-console.html">Extending the Apache Felix Web Console</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../subprojects/apache-felix-web-console/web-console-restful-api.html">Web Console RESTful API</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../subprojects/apache-felix-web-console/web-console-security-provider.html">Web Console Security Provider</a>
   </li>
   <li class="nav-item" data-depth="3">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Extensions</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/branding-the-web-console.html">Branding the Web Console</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/providing-resources.html">Providing Resources</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/providing-web-console-plugins.html">Providing Web Console Plugins</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/web-console-logging.html">Web Console Logging</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/web-console-output-templating.html">Web Console Output Templating</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../tutorials-examples-and-presentations.html">Tutorials</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-application-demonstration.html">Apache Felix Application Demonstration</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial.html">Apache Felix OSGi Tutorial</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-faq.html">OSGi Frequently Asked Questions</a>
   </li>
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">OSGI Tutorial</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-1.html">Apache Felix Tutorial Example 1 - Service Event Listener Bundle</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-2.html">Apache Felix Tutorial Example 2</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-2b.html">Apache Felix Tutorial Example 2b</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-3.html">Apache Felix Tutorial Example 3</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-4.html">Apache Felix Tutorial Example 4</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-5.html">Apache Felix Tutorial Example 5</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-6.html">Example 6 - Spell Checker Service Bundle</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-7.html">Example 7 - Spell Checker Client Bundle</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-8.html">Example 8 - Spell Checker Service using Service Binder</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-9.html">Example 9 - Spell Checker Service using Declarative Services</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../license.html">Apache License 2.0</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../site-map.html">Site map</a>
   </li>
 </ul>
   </li>
 </ul>
   </nav>
 </div>
 <div class="nav-panel-explore" data-panel="explore">
   <div class="context">
     <span class="title">Documentation</span>
     <span class="version">master</span>
   </div>
   <ul class="components">
     <li class="component is-current">
       <span class="title">Documentation</span>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">master</a>
         </li>
       </ul>
     </li>
   </ul>
 </div>
     </div>
   </aside>
 </div>
 <main class="article">
 <div class="toolbar" role="navigation">
 <button class="nav-toggle"></button>
   <a href="../index.html" class="home-link"></a>
 <nav class="breadcrumbs" aria-label="breadcrumbs">
   <ul>
     <li><a href="../index.html">Documentation</a></li>
     <li>Community</li>
     <li><a href="contributing.html">Contributing</a></li>
   </ul>
 </nav>
   <div class="edit-this-page"><a href="https://github.com/apache/felix-antora-site/edit/main/modules/ROOT/pages/community/contributing.adoc">Edit this Page</a></div>
   </div>
   <div class="content">
 <article class="doc">
 <h1 class="page">Contributing</h1>
 <div id="preamble">
 <div class="sectionbody">
 <div class="paragraph">
 <p>Apache Felix is a volunteer effort, so there is always plenty of work that needs to be accomplished.
 If you want to help support Felix, this page is intended as a starting point for specific contribution ideas.
 To further understand how the Felix community operates, refer to the <a href="https://www.apache.org/foundation/how-it-works.html">Community Roles and Processes</a> document and/or join the <a href="project-info.html" class="page">mailing lists</a>.</p>
 </div>
 <div class="paragraph">
 <p>The Felix project organizes its "to do" list using the <a href="https://issues.apache.org/jira/browse/Felix">JIRA</a> issue tracking system.
 Specific items from Felix' JIRA issue tracking system are highlighted on this page, but are not limited to it.
 The purpose of the list here is to highlight issues that are either more important or serve as good entry points for new contributors.</p>
 </div>
 <div class="paragraph">
 <p>It is important to point out that you do not need to be a programmer to contribute to Felix.
 As such, we will break out the list of issues below for non-programmers and programmers.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_non_programmers"><a class="anchor" href="#_non_programmers"></a>Non-Programmers</h2>
 <div class="sectionbody">
 <div class="ulist">
 <ul>
 <li>
 <p>Improve web site or documentation (e.g., create/propose FAQ entries).
 There is no specific JIRA issue for this task, but any contributions could be posted as new JIRA issues for the Documentation component.</p>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_programmers"><a class="anchor" href="#_programmers"></a>Programmers</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>Before contributing, make sure to be subscribed to the <a href="project-info.html" class="page">developer mailing list</a>.
 If you don&#8217;t have your own issue to scratch, you can browse open issues in <a href="https://issues.apache.org/jira/browse/Felix">JIRA</a> and submit a patch.</p>
 </div>
 <div class="paragraph">
 <p>Source code contributions fall into two categories: pull requests or grants.
 This document describes both and how to handle each.</p>
 </div>
 <div class="sect2">
 <h3 id="_pull_requests"><a class="anchor" href="#_pull_requests"></a>Pull Requests</h3>
 <div class="paragraph">
 <p>A pull request is a small change to existing code, typically in response to a bug fix or improvement.
 If you have created a change, you should:</p>
 </div>
 <div class="olist arabic">
 <ol class="arabic">
 <li>
 <p>Create a <a href="https://issues.apache.org/jira/browse/Felix">JIRA</a> issue (or find a pertinent existing issue) describing the issue needing to be addressed.</p>
 </li>
 <li>
 <p>Create a pull requests against the git repository containing the code.</p>
 </li>
 <li>
 <p>The pull request will eventually be reviewed and applied (if accepted) by a Felix committer, but feel free to bug us [nicely]({{ refs.nicely.adoc) if you get impatient.</p>
 </li>
 </ol>
 </div>
 <div class="paragraph">
 <p>Providing pull requests is a very good way to become a committer at Felix, since we&#8217;d rather have you review and apply the patches than us.
 :-)</p>
 </div>
 </div>
 <div class="sect2">
 <h3 id="_grants"><a class="anchor" href="#_grants"></a>Grants</h3>
 <div class="paragraph">
 <p>A grant involves donating a larger chunk of code developed elsewhere.
 The line dividing a patch and a grant is sort of like the definition of pornography, we know it when we see it.
 The steps for granting software are a little more complicated since we need to ensure proper IP handling.
 For grants, you should:</p>
 </div>
 <div class="olist arabic">
 <ol class="arabic">
 <li>
 <p>Verify that you have the authorization to donate the code.</p>
 </li>
 <li>
 <p>Review our <a href="../development/coding-standards.html" class="page">developer documentation</a> as well as the general <a href="https://www.apache.org/foundation/getinvolved.html">Apache documentation</a> to determine whether you would really like be involved with us and how we work.</p>
 </li>
 <li>
 <p>Assuming you&#8217;re still interested, create a <a href="https://issues.apache.org/jira/browse/Felix">JIRA</a> issue describing the code you wish to donate.</p>
 </li>
 <li>
 <p>Attach an archive containing the code along with an MD5 signature of the archive to the above issue.
 You should remove any existing headers from the source files and add the standard Apache header to each.
 Note that you keep the rights to your code and can do anything with it you want, you will just grant us the right to use it too.</p>
 </li>
 <li>
 <p>Allow the community time to discuss the contribution, after which a vote will be called to accept the contribution.</p>
 </li>
 <li>
 <p>If the vote passes, then you will need to submit a <a href="https://www.apache.org/licenses/software-grant.txt">software grant</a> form.</p>
 </li>
 <li>
 <p>It is also a good idea to submit an <a href="https://www.apache.org/licenses/icla.txt">ICLA</a> to ease future contributions. Depending on the company you work for, they may also want to contribute a <a href="https://www.apache.org/licenses/cla-corporate.txt">CCLA</a>, although this isn&#8217;t strictly necessary from an Apache point of view, since it is your responsibility to verify your ability to submit an ICLA.</p>
 </li>
 <li>
 <p>Once all of this information is received, then we will gather it and perform <a href="https://incubator.apache.org/ip-clearance/index.html">IP clearance</a>.</p>
 </li>
 <li>
 <p>After a few days, if no red flags are raised, then we&#8217;ll commit the code and we&#8217;re good to go.</p>
 </li>
 </ol>
 </div>
 <div class="paragraph">
 <p>Granting code is also a path to committership at Felix, since we look more highly on contributions from developers who wish to stay involved in the continuing evolution and maintenance of the donated code.</p>
 </div>
 </div>
 </div>
 </div>
 </article>
 <aside class="toc sidebar" data-title="Contents" data-levels="2">
   <div class="toc-menu"></div>
 </aside>
   </div>
 </main>
 </div>
 <footer class="footer">
   <p>Content licensed under AL2. UI licensed under MPL-2.0 with extensions licensed under AL2</p>
 </footer>
 <script src="../../_/js/site.js"></script>
 <script async src="../../_/js/vendor/highlight.js"></script>
   </body>
 </html>