The following code of conduct is based on full compliance with ASF CODE OF CONDUCT.
./mvnw clean installcan be compiled and tested successfully.
https://github.com/apache/shardingsphere/blob/master/src/resources/checkstyle.xml, please use checkstyle
8.8to run the rules.
pull request; Small and frequent
pull requestwith complete unit function is welcomed.
Contributor Covenant Code of Conductbelow.
result; Variables in the loop structure are named with
ex; Exceptions when catch but do nothing are named with
equalsconditional expressions; Have variable on the left and constants on the right in
less thanconditional expressions.
finalclass expect abstract class for extend.
nullparameters or return values.
LinkedListin priority. Use
ArrayListfor use index to get element only.
HashMapmust indicate initial capacity to avoid recalculate capacity.
publicclasses and methods need javadoc, other methods, classes and override methods do not need javadoc.
logare prohibited, use assert to check test results.
Mockitocan use static import.
assertNotNullshould be used.
assertThatshould be used.
containsStringto make assertions.
actualXXX, expected values
@Testannotation do not need javadoc.
200chars, guarantee every line have complete semantics.
underlineto separate. Rule name of
Symbolshould end with
underline. If rule name is conflicted with ANTLR's keyword, should take an
underlinebehind rule name.
fragment, rule with
fragmentshould define behind of public rule which they served.
Keyword.g4, every database may has customized rule file by themselves. For example:
semicolonshould take a new line and keep indents (including blank lines) consistent with the previous one.
5, every branch take a new line.
Statement. For example:
：Code submit frequency
：React/respond to issue & PR etc.
：Well-balanced team members and collaboration
：Recent popularity of project
：Star counts, download counts etc.