Yuri Schimke <******@****.***> 1773565238 +0000

When defining conventions for a property, there are largely three approaches:
1. Do not set a convention at all
2. Set a convention in a plugin
3. Set a convention in a constructor

Most properties should have a convention set, so (1) can be treated as a rare case where a value must be provided by a user.

plugins {
  kotlin("jvm")
  id("okhttp.publish-conventions")
  id("okhttp.jvm-conventions")
  id("okhttp.quality-conventions")
  id("okhttp.testing-conventions")
}

project.applyJavaModules("okhttp3.mockwebserver")

dependencies {
  "friendsApi"(projects.okhttp)
  api(projects.mockwebserver3)
  api(libs.junit)
  api(libs.square.okio)

  testImplementation(projects.okhttpTestingSupport)
  testImplementation(projects.okhttpTls)

* **Historical compatibility**: Existing public API methods that are part of Gradle's stable API cannot be renamed due to backward compatibility requirements (though new APIs should use American English)
* **Proper nouns and quotes**: Names of organizations, products, or quoted text that use different conventions

## Consequences

### Positive Consequences

## About versions { #about-versions }

Following the Semantic Versioning conventions, any version below `1.0.0` could potentially add breaking changes.

FastAPI also follows the convention that any "PATCH" version change is for bug fixes and non-breaking changes.

/// tip

The "PATCH" is the last number, for example, in `0.2.3`, the PATCH version is `3`.

mvn formatter:format                  # Format code
mvn license:format                    # Apply license headers
mvn verify                            # Generate coverage report
```

## Code Conventions

### Class Structure

- **Utility classes**: `abstract` class + `protected` constructor
- **Constants classes**: Same pattern

### Argument Validation

Use `AssertionUtil` at method entry:

---

## Code Conventions

### Java Style

- **Formatter**: Eclipse formatter at `src/config/eclipse/formatter/java.xml`
- **Indentation**: 4 spaces (no tabs)
- **Line Length**: 140 characters max
- **License Headers**: Required (use `mvn license:format`)

### Naming & Style

- **Flexibility and Control:**
Java serialization offers limited control over the serialization process, such as excluding certain fields, customizing naming conventions, and handling complex data structures more gracefully.

- **Security:**
Java serialization poses security risks, especially related to deserialization vulnerabilities.

- **Version Compatibility:**

Previously, there was no formalization of property naming; only loose conventions were followed.
While these conventions served relatively well in practice, they created gaps, resulting in a loss of uniformity in some cases and leaving friction in the process of naming new properties.

### Terminology

- Authentication: Local (UserService), LDAP, OIDC, SAML, SPNEGO, Entra ID
- Security features: AES encryption, SHA256 digest, LDAP injection prevention, password policy, rate limiting

## Naming Conventions

| Element | Convention | Example |
|---------|------------|---------|
| Classes | PascalCase | `UserService`, `FessBaseAction` |
| Methods | camelCase + verb | `getUserList()`, `setupHtmlData()` |