Update docs best I can

Author: BryceStevenWilley

CONTRIBUTING.md

@@ -2,9 +2,34 @@
 
 ## Project Background and Context
 
-TODO
+This project is a part of the [Document Assembly Line](https://assemblyline.suffolklitlab.org/) as a part of the Suffolk LIT Lab.
+
+This project is primarly meant as an intermediatary between programs that want to e-file document with courts and
+E-Filing Managers, specifically Tyler Technologies[^1]. While this project is [open source](LICENSE), we don't have control
+over access to Tyler Technologies' servers, which will make it difficult to use or test this software if you aren't a part of
+the Assembly Line team.
+
+While we still welcome contributions and can help debug issues and patches, we cannot help with getting access keys from Tyler.
+You can reach out to [Tyler's eFile and Serve](https://www.tylertech.com/products/enterprise-justice/efile-serve) team
+to learn more. 
 
 ## Building and Running
 
 See the [README.md] and [docs/setup.md] for more details on how to build locally, and [docs/developing.md] for technical 
 details to keep in mind when writing code.
+
+## Making PRs
+
+To make a PR on our GitHub project, follow [this guide from GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
+
+When you make your PR, don't forget to make sure that your changes pass our
+continuous integration (CI). The CI scripts are found in `.github/workflows`,
+but in general you should run the following commands before making a PR:
+
+* `mvn -Preproducible verify` (build the Java project)
+* `mvn compile javadoc:javadoc` (build the Javadoc documentation)
+* `docker build .` (build the Docker image)
+* `mvn spotless:apply` (formats your code)
+
+
+[^1]: While we have intentions of expanding to work with additional EFMs, the only one we work with is Tyler's implementation of ECF 4.

Dockerfile

@@ -1,8 +1,6 @@
 FROM maven:3.8-eclipse-temurin-21 AS build
 ARG CI_COMMIT_SHA
 LABEL git-commit=$CI_COMMIT_SHA
-# The `[]` is an optional COPY: doesn't copy if those files aren't there (https://stackoverflow.com/a/46801962/11416267)
-# They are needed for Tyler API usage
 COPY pom.xml /app/
 COPY EfspCommons /app/EfspCommons/
 COPY TylerEcf4 /app/TylerEcf4/

EfspCommons/README.md

@@ -0,0 +1,3 @@
+# EFSP Commons
+
+The Java project with common classes not related to any specific type of application that are used in all other packages.

EfspCommons/src/main/java/edu/suffolk/litlab/efsp/stdlib/NonEmptyString.java

@@ -2,6 +2,7 @@
 
 import java.util.Optional;
 
+/** A class that is guaranteed to contain a non-empty/non-blank/non-null string. */
 public class NonEmptyString {
   private final String data;
 

EfspCommons/src/main/java/edu/suffolk/litlab/efsp/stdlib/RandomString.java

@@ -13,27 +13,28 @@ public class RandomString {
 
   /** Generate a random string. */
   public String nextString() {
-    for (int idx = 0; idx < buf.length; ++idx) buf[idx] = symbols[random.nextInt(symbols.length)];
+    for (int idx = 0; idx < buf.length; ++idx) {
+      buf[idx] = symbols[random.nextInt(symbols.length)];
+    }
     return new String(buf);
   }
 
   public static final String upper = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
-
   public static final String lower = upper.toLowerCase(Locale.ROOT);
-
   public static final String digits = "0123456789";
-
   public static final String alphanum = upper + lower + digits;
 
   private final Random random;
-
   private final char[] symbols;
-
   private final char[] buf;
 
   public RandomString(int length, Random random, String symbols) {
-    if (length < 1) throw new IllegalArgumentException();
-    if (symbols.length() < 2) throw new IllegalArgumentException();
+    if (length < 1) {
+      throw new IllegalArgumentException();
+    }
+    if (symbols.length() < 2) {
+      throw new IllegalArgumentException();
+    }
     this.random = random;
     this.symbols = alphanum.toCharArray();
     this.buf = new char[length];

EfspCommons/src/main/java/edu/suffolk/litlab/efsp/stdlib/SQLFunction.java

@@ -2,6 +2,15 @@
 
 import java.sql.SQLException;
 
+/**
+ * A "Function" function type that could throw a SQLException.
+ *
+ * <p>Necessary because the built-in Function interface doesn't allow throwing checked exceptions.
+ * 
+ * @param <T> the input type for this interface
+ * @param <R> the type returned by this interface
+ * @see edu.suffolk.litlab.efsp.stdlib.SQLGetter
+ */
 @FunctionalInterface
 public interface SQLFunction<T, R> {
   R apply(T input) throws SQLException;

EfspCommons/src/main/java/edu/suffolk/litlab/efsp/stdlib/SQLGetter.java

@@ -2,6 +2,15 @@
 
 import java.sql.SQLException;
 
+/**
+ * A "Supplier" function type that could throw a SQLException.
+ *
+ * <p>Necessary because the built-in Supplier doesn't allow throwing checked exceptions.
+ * 
+ * @param <R> the type returned by this interface
+ *
+ * @see edu.suffolk.litlab.efsp.stdlib.SQLFunction
+ */
 @FunctionalInterface
 public interface SQLGetter<R> {
   R get() throws SQLException;

EfspCommons/src/main/java/edu/suffolk/litlab/efsp/stdlib/StdLib.java

@@ -1,14 +1,10 @@
 package edu.suffolk.litlab.efsp.stdlib;
 
 import java.util.Optional;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /** Things that really should just be in the standard lib. */
 public class StdLib {
-  private static final Logger log = LoggerFactory.getLogger(StdLib.class);
-
-  /** Quick wrapper to get an env var as an optional. */
+  /** Wrapper to get an env var as an optional: there if present, empty if not. */
   public static Optional<String> GetEnv(String envVarName) {
     String val = System.getenv(envVarName);
     if (val == null || val.isBlank()) {

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Suffolk Legal Innovation and Technology Lab
+Copyright (c) 2026 Suffolk Legal Innovation and Technology Lab
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -25,7 +25,7 @@ Docker env files can't be directly used in `bash`, so if you are running things
 
 ### Making API Tokens
 
-When running locally, run `./local_create_api_key.sh`.
+When running locally, run `./scripts/local_create_api_key.sh`.
 
 The API token to add to the docassemble config will be printed out.