Welcome! We really hope you are here because you are seriously thinking about adding to the EdgeX Foundry IoT platform. We can't wait to receive your contribution! Before you make your first submission, this page has been set up to help guide you through some information you need to know before working on and contributing code to the EdgeX project.
Committing Code Guidelines (posted for review and comment)
| View file | ||||
|---|---|---|---|---|
|
Code Style Guides
The EdgeX project technical community has adopted the Google Style Guides for all programming languages. As most of the EdgeX code is in Java today, you will find the Java guide helpful: https://google.github.io/styleguide/javaguide.html.
...
<configuration>
<configLocation>google_checks.xml</configLocation>
<consoleOutput>true</consoleOutput>
<violationSeverity>error</violationSeverity>
<skip>false</skip>
<linkXRef>false</linkXRef>
<includeTestSourceDirectory>true</includeTestSourceDirectory>
<outputFile>${project.build.directory}/edgex-checkstyles-result.xml</outputFile>
</configuration>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
<pluginManagement>
<plugins>
<!--This plugin's configuration is used to store Eclipse m2e settings
only. It has no influence on the Maven build itself. -->
<plugin>
<groupId>org.eclipse.m2e</groupId>
<artifactId>lifecycle-mapping</artifactId>
<version>1.0.0</version>
<configuration>
<lifecycleMappingMetadata>
<pluginExecution>
<pluginExecutionFilter>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<versionRange>[2.17,)</versionRange>
<goals>
<goal>check</goal>
</goals>
</pluginExecutionFilter>
<action>
<ignore></ignore>
</action>
</pluginExecution>
</pluginExecutions>
</lifecycleMappingMetadata>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
Bug Tracking
EdgeX uses GitHub Issues to submit and track bugs.
...