Setup & Standards

Tue, 15 Oct 2024 00:00:00 +0000

Local Developer Setup

Prerequisite(s):

IntelliJ application installed on machine
Java project

Setting up Google Code Formatting Scheme

Make sure that Intellij is open
Go to the following link: styleguide/intellij-java-google-style.xml at gh-pages · google/styleguide
Download the .xml file
Open the file in an editor of your choice
Navigate to the <option …> tag with name ‘Right Margin’ and edit the value to be 132 (it should default as 100)
Save the file
In Intellij IDEA, navigate to Settings | Preferences → Code Style → Editor → Java
Click on the gear icon on the right panel and drill down to the option Import Scheme and then to Intellij IDEA Code Style XML
In the file explorer that opens, navigate to where you stored the aforementioned .xml file we downloaded
After selecting the file, you should see a pop-up allowing you to name the scheme; select a name and click ‘Okay’
Click ‘Apply’ in the Settings panel
Restart the IDE; You can use the ‘Reformat Code’ option to apply the plug-in on your code

Excluding Non-Java Files

Assuming that we don’t want to auto-format non-java files via a directory level ‘Reformat Code’ option, we need to exclude all other files from being reformatted

Developing New Components

Mon, 28 Oct 2024 00:00:00 +0000

Introduction

This guide covers the basics of how to develop new components for Lucille along with an understanding of required and optional components. After reading this, you should be able to start development with a good foundation on how testing works, how configuration is handled, and what features the base classes affords us.

Prerequisites

An up-to-date version of Lucille that has been appropriately installed
Understanding of Java programming language
Understanding of Lucille

Contribution Guidelines on Lucille