Date: Thu, 28 Mar 2024 08:21:26 -0400 (EDT) Message-ID: <717291457.27692.1711628486681@lyrasis1-roc-mp1> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_27691_1503554273.1711628486681" ------=_Part_27691_1503554273.1711628486681 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The code style conventions used in the project are based on the style-guide defined of Fe= dora-3. They should prevent commits cluttered with format changes.
Here are the major rules:
K&R style braces
if (cod= e) { // code } else { // code }
Create Javadocs for types of at least the following descrip= tivity
/** * @author Joe Developer * @since MMM DD, YYYY */ public class MyClass
Each source file should contain a=
license header much like the following:
/** * Copyright 2015 DuraSpace, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */
Use the maven-license-plugin to check= for and add missing headers:
mvn lic= ense:check
mvn lic= ense:format
IDE settings are located in the project source. IDE users are strongly r= ecommended to apply these formatting settings.
We're in the process of adding checkstyle enforcement t= o our modules (meaning, if you violate some of the major style rules, the b= uild will fail).
To check for violations, run the following command:
mvn che= ckstyle:check