Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/Team766/MaroonFramework i…
Browse files Browse the repository at this point in the history 
…nto integrate-advantagekit
  • Loading branch information
@dejabot
dejabot committed Jan 14, 2024
2 parents d2703e0 + bce4df0 commit 74493ac
Show file tree
Hide file tree
Showing 58 changed files with 5,282 additions and 3,417 deletions.
275 changes: 130 additions & 145 deletions .github/linters/checkstyle.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,206 +3,191 @@
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">

<!--
Checkstyle configuration that checks the sun coding conventions from:
- the Java Language Specification at
https://docs.oracle.com/javase/specs/jls/se11/html/index.html
- the Sun Code Conventions at https://www.oracle.com/java/technologies/javase/codeconventions-contents.html
- the Javadoc guidelines at
https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
- the JDK Api documentation https://docs.oracle.com/en/java/javase/11/
- some best practices
Checkstyle is very configurable. Be sure to read the documentation at
https://checkstyle.org (or in your downloaded distribution).
Most Checks are configurable, be sure to consult the documentation.
To completely disable a check, just comment it out or delete it from the file.
To suppress certain violations please review suppression filters.
Finally, it is worth reading the documentation.
-->
<!-- Checkstyle configuration that checks the sun coding conventions from:
- the Java Language Specification at https://docs.oracle.com/javase/specs/jls/se11/html/index.html
- the Sun Code Conventions at https://www.oracle.com/java/technologies/javase/codeconventions-contents.html
- the Javadoc guidelines at https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
- the JDK Api documentation https://docs.oracle.com/en/java/javase/11/ -
some best practices Checkstyle is very configurable. Be sure to read the
documentation at https://checkstyle.org (or in your downloaded distribution).
Most Checks are configurable, be sure to consult the documentation. To completely
disable a check, just comment it out or delete it from the file. To suppress
certain violations please review suppression filters. Finally, it is worth
reading the documentation. -->

<module name="Checker">
<!--
If you set the basedir property below, then all reported file
names will be relative to the specified directory. See
https://checkstyle.org/config.html#Checker
<!-- If you set the basedir property below, then all reported file names
will be relative to the specified directory. See https://checkstyle.org/config.html#Checker
<property name="basedir" value="${basedir}"/> -->
<property name="severity" value="error" />

<property name="basedir" value="${basedir}"/>
-->
<property name="severity" value="error"/>
<property name="fileExtensions" value="java, properties, xml" />

<property name="fileExtensions" value="java, properties, xml"/>

<!-- Excludes all 'module-info.java' files -->
<!-- Excludes all 'module-info.java' files -->
<!-- See https://checkstyle.org/filefilters/index.html -->
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$"/>
<property name="fileNamePattern" value="module\-info\.java$" />
</module>

<!-- https://checkstyle.org/filters/suppressionfilter.html -->
<module name="SuppressionFilter">
<property name="file" value="${org.checkstyle.sun.suppressionfilter.config}"
default="checkstyle-suppressions.xml" />
<property name="optional" value="true"/>
<property name="file"
value="${org.checkstyle.sun.suppressionfilter.config}"
default="checkstyle-suppressions.xml" />
<property name="optional" value="true" />
</module>

<!-- Checks whether files end with a new line. -->
<!-- Checks whether files end with a new line. -->
<!-- See https://checkstyle.org/checks/misc/newlineatendoffile.html -->
<!--<module name="NewlineAtEndOfFile"/>-->
<!--<module name="NewlineAtEndOfFile"/> -->

<!-- Checks that property files contain the same keys. -->
<!-- Checks that property files contain the same keys. -->
<!-- See https://checkstyle.org/checks/misc/translation.html -->
<module name="Translation"/>
<module name="Translation" />

<!-- Checks for Size Violations. -->
<!-- Checks for Size Violations. -->
<!-- See https://checkstyle.org/checks/sizes/index.html -->
<!--<module name="FileLength"/>-->
<!--<module name="FileLength"/> -->

<!-- Checks for whitespace -->
<!-- Checks for whitespace -->
<!-- See https://checkstyle.org/checks/whitespace/index.html -->
<!--<module name="FileTabCharacter"/>-->
<!--<module name="FileTabCharacter"/> -->

<!-- Miscellaneous other checks. -->
<!-- Miscellaneous other checks. -->
<!-- See https://checkstyle.org/checks/misc/index.html -->
<!--<module name="RegexpSingleline">
<property name="format" value="\s+$"/>
<property name="minimum" value="0"/>
<property name="maximum" value="0"/>
<property name="message" value="Line has trailing spaces."/>
</module>-->

<!-- Checks for Headers -->
<!-- See https://checkstyle.org/checks/header/index.html -->
<!--<module name="RegexpSingleline"> <property name="format" value="\s+$"/>
<property name="minimum" value="0"/> <property name="maximum" value="0"/>
<property name="message" value="Line has trailing spaces."/> </module> -->

<!-- Checks for Headers -->
<!-- See https://checkstyle.org/checks/header/index.html -->
<!-- <module name="Header"> -->
<!-- <property name="headerFile" value="${checkstyle.header.file}"/> -->
<!-- <property name="fileExtensions" value="java"/> -->
<!-- <property name="headerFile" value="${checkstyle.header.file}"/> -->
<!-- <property name="fileExtensions" value="java"/> -->
<!-- </module> -->

<module name="LineLength">
<property name="fileExtensions" value="java"/>
<property name="max" value="500"/>
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
<property name="severity" value="warning"/>
<property name="fileExtensions" value="java" />
<property name="max" value="500" />
<property name="ignorePattern"
value="^package.*|^import.*|a href|href|http://|https://|ftp://" />
<property name="severity" value="warning" />
</module>

<module name="TreeWalker">

<!-- Checks for Javadoc comments. -->
<!-- Checks for Javadoc comments. -->
<!-- See https://checkstyle.org/checks/javadoc/index.html -->
<!--<module name="InvalidJavadocPosition"/>
<module name="JavadocMethod"/>
<module name="JavadocType"/>
<module name="JavadocVariable"/>
<module name="JavadocStyle"/>
<module name="MissingJavadocMethod"/>-->

<!-- Checks for Naming Conventions. -->
<!--<module name="InvalidJavadocPosition"/> <module name="JavadocMethod"/>
<module name="JavadocType"/> <module name="JavadocVariable"/> <module name="JavadocStyle"/>
<module name="MissingJavadocMethod"/> -->

<!-- Checks for Naming Conventions. -->
<!-- See https://checkstyle.org/checks/naming/index.html -->
<!--<module name="ConstantName"/>-->
<!--<module name="LocalFinalVariableName"/>-->
<!--<module name="LocalVariableName"/>-->
<!--<module name="MemberName"/>-->
<module name="MethodName"/>
<module name="PackageName"/>
<!--<module name="ParameterName"/>-->
<!--<module name="StaticVariableName"/>-->
<!--<module name="TypeName"/>-->

<!-- Checks for imports -->
<!--<module name="ConstantName"/> -->
<!--<module name="LocalFinalVariableName"/> -->
<!--<module name="LocalVariableName"/> -->
<!--<module name="MemberName"/> -->
<module name="MethodName" />
<module name="PackageName" />
<!--<module name="ParameterName"/> -->
<!--<module name="StaticVariableName"/> -->
<!--<module name="TypeName"/> -->

<!-- Checks for imports -->
<!-- See https://checkstyle.org/checks/imports/index.html -->
<!--<module name="AvoidStarImport"/>-->
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
<module name="RedundantImport"/>
<!--<module name="AvoidStarImport"/> -->
<module name="IllegalImport" /> <!-- defaults to sun.* packages -->
<module name="RedundantImport" />
<module name="UnusedImports">
<property name="severity" value="warning"/>
<property name="severity" value="warning" />
</module>

<!-- Checks for Size Violations. -->
<!-- Checks for Size Violations. -->
<!-- See https://checkstyle.org/checks/sizes/index.html -->
<module name="MethodLength"/>
<module name="ParameterNumber"/>
<!--<module name="MethodLength"/> -->
<module name="ParameterNumber" />

<!-- Checks for whitespace -->
<!-- Checks for whitespace -->
<!-- See https://checkstyle.org/checks/whitespace/index.html -->
<module name="EmptyForIteratorPad"/>
<module name="GenericWhitespace"/>
<module name="MethodParamPad"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<!--<module name="OperatorWrap"/>-->
<module name="ParenPad"/>
<module name="TypecastParenPad"/>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround"/>

<!-- Modifier Checks -->
<module name="EmptyForIteratorPad" />
<module name="GenericWhitespace" />
<module name="MethodParamPad" />
<module name="NoWhitespaceAfter" />
<module name="NoWhitespaceBefore" />
<!--<module name="OperatorWrap"/> -->
<module name="ParenPad" />
<module name="TypecastParenPad" />
<module name="WhitespaceAfter" />
<module name="WhitespaceAround">
<property name="allowEmptyCatches" value="true" />
<property name="allowEmptyConstructors" value="true" />
<property name="allowEmptyLambdas" value="true" />
<property name="allowEmptyLoops" value="true" />
<property name="allowEmptyMethods" value="true" />
</module>

<!-- Modifier Checks -->
<!-- See https://checkstyle.org/checks/modifier/index.html -->
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>
<module name="ModifierOrder" />
<module name="RedundantModifier" />

<!-- Checks for blocks. You know, those {}'s -->
<!-- Checks for blocks. You know, those {}'s -->
<!-- See https://checkstyle.org/checks/blocks/index.html -->
<!--<module name="AvoidNestedBlocks"/>-->
<module name="EmptyBlock"/>
<module name="LeftCurly"/>
<module name="NeedBraces"/>
<module name="RightCurly"/>
<!--<module name="AvoidNestedBlocks"/> -->
<module name="EmptyBlock" />
<module name="LeftCurly" />
<module name="NeedBraces" />
<module name="RightCurly" />

<!-- Checks for common coding problems -->
<!-- Checks for common coding problems -->
<!-- See https://checkstyle.org/checks/coding/index.html -->
<module name="EmptyStatement"/>
<!--<module name="EqualsHashCode"/>-->
<module name="EmptyStatement" />
<!--<module name="EqualsHashCode"/> -->
<module name="HiddenField">
<property name="severity" value="warning"/>
<property name="severity" value="warning" />
</module>
<module name="IllegalInstantiation"/>
<!--<module name="InnerAssignment"/>-->
<!--<module name="MagicNumber"/>-->
<module name="MissingSwitchDefault"/>
<module name="MultipleVariableDeclarations"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>

<!-- Checks for class design -->
<module name="IllegalInstantiation" />
<!--<module name="InnerAssignment"/> -->
<!--<module name="MagicNumber"/> -->
<module name="MissingSwitchDefault" />
<module name="MultipleVariableDeclarations" />
<module name="SimplifyBooleanExpression" />
<module name="SimplifyBooleanReturn" />

<!-- Checks for class design -->
<!-- See https://checkstyle.org/checks/design/index.html -->
<!--<module name="DesignForExtension"/>-->
<!--<module name="DesignForExtension"/> -->
<module name="FinalClass">
<property name="severity" value="warning"/>
<property name="severity" value="warning" />
</module>
<!--<module name="HideUtilityClassConstructor"/>-->
<module name="InterfaceIsType"/>
<!--<module name="VisibilityModifier"/>-->
<!--<module name="HideUtilityClassConstructor"/> -->
<module name="InterfaceIsType" />
<!--<module name="VisibilityModifier"/> -->

<!-- Miscellaneous other checks. -->
<!-- Miscellaneous other checks. -->
<!-- See https://checkstyle.org/checks/misc/index.html -->
<module name="ArrayTypeStyle"/>
<!--<module name="FinalParameters"/>-->
<!--<module name="TodoComment"/>-->
<module name="UpperEll"/>
<module name="ArrayTypeStyle" />
<!--<module name="FinalParameters"/> -->
<!--<module name="TodoComment"/> -->
<module name="UpperEll" />

<!-- https://checkstyle.org/filters/suppressionxpathfilter.html -->
<module name="SuppressionXpathFilter">
<property name="file" value="${org.checkstyle.sun.suppressionxpathfilter.config}"
default="checkstyle-xpath-suppressions.xml" />
<property name="optional" value="true"/>
<property name="file"
value="${org.checkstyle.sun.suppressionxpathfilter.config}"
default="checkstyle-xpath-suppressions.xml" />
<property name="optional" value="true" />
</module>

<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>
<property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
</module>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat"
value="CHECKSTYLE.OFF\: ([\w\|]+)" />
<property name="onCommentFormat"
value="CHECKSTYLE.ON\: ([\w\|]+)" />
<property name="checkFormat" value="$1" />
</module>

</module>

</module>
</module>
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Description

Please include a summary of the changes in this PR. If it is fixing an issue, describe the issue. Please also include relevant motivation and context such that a newer programmer could understand your changes just by reading this description.


## How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Be detailed so that your code reviewer can understand exactly how much and what kinds of testing were done, and which might still be worthwhile to do.

- [ ] Unit tests: [Add your description here]
- [ ] Simulator testing: [Add your description here]
- [ ] On-robot bench testing: [Add your description here]
- [ ] On-robot field testing: [Add your description here]
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ jobs:
with:
arguments: publish
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
34 changes: 0 additions & 34 deletions .github/workflows/linter.yml
View file

This file was deleted.

Loading

0 comments on commit 74493ac

Please sign in to comment.