diff --git a/.agents/purpose.md b/.agents/purpose.md index 224297388..d6aeebb42 100644 --- a/.agents/purpose.md +++ b/.agents/purpose.md @@ -1,6 +1,6 @@ # 🧠 Purpose -> **EXECUTIVE SUMMARY**: This guide outlines how AI agents (ChatGPT, Codex, Junie, Claude, Gemeni) +> **EXECUTIVE SUMMARY**: This guide outlines how AI agents (ChatGPT, Codex, Junie, Claude, Gemini) > collaborate on our Kotlin/Java project. It defines responsibilities, coding standards, > and workflows to maintain high code quality and architectural integrity. diff --git a/.agents/running-builds.md b/.agents/running-builds.md index db0338d6f..01988fdb0 100644 --- a/.agents/running-builds.md +++ b/.agents/running-builds.md @@ -5,7 +5,7 @@ ./gradlew build ``` -2. If Protobuf (`.proto`) files are modified run: +2. If Protobuf (`.proto`) files are modified, run: ```bash ./gradlew clean build ``` diff --git a/.idea/live-templates/README.md b/.idea/live-templates/README.md index 66713b347..3c9a2ae56 100644 --- a/.idea/live-templates/README.md +++ b/.idea/live-templates/README.md @@ -5,7 +5,7 @@ This directory contains two live template groups: 1. `Spine.xml`: shortcuts for the repeated patterns used in the framework. 2. `User.xml`: a single shortcut to generate TODO comments. -### Instlallation +### Installation Live templates are not picked up by IDEA automatically. They should be added manually. In order to add these templates, perform the following steps: @@ -22,6 +22,6 @@ In order to add these templates, perform the following steps: 1. Open the corresponding template: `Preferences -> Editor -> Live Templates -> User.todo`. 2. Click on `Edit variables`. -3. Set `USER` variable to your domain email address without `@teamdev.com` ending. For example, - for `jack.sparrow@teamdev.com` use the follwoing expression `"jack.sparrow"`. +3. Set `USER` variable to your domain email address without `@teamdev.com` ending. For example, + for `jack.sparrow@teamdev.com` use the following expression `"jack.sparrow"`. 4. Verify that the template generates expected comments: `// TODO:2022-11-03:jack.sparrow: <...>`. diff --git a/GEMENI.md b/GEMINI.md similarity index 100% rename from GEMENI.md rename to GEMINI.md diff --git a/README.md b/README.md index 086823824..71db1a362 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,11 @@ Spine Logging is a versatile library designed for Kotlin and Java projects, with a potential for multi-platform use. -As for now, only JVM target is supported, with a JavaScript implementation +As of now, only JVM target is supported, with a JavaScript implementation being our priority for future development. API and implementation are largely inspired by [Google Flogger][flogger], -and the introduction of fluent logging API in [SLF4J in v2.0.0][fluent-slf4j]. +and the introduction of fluent logging API in [SLF4J v2.0.0][fluent-slf4j]. ## Current status: Experimental diff --git a/backends/probe-backend/README.md b/backends/probe-backend/README.md index bbbab725f..ddfa74b4f 100644 --- a/backends/probe-backend/README.md +++ b/backends/probe-backend/README.md @@ -12,7 +12,7 @@ instance or intercept the logged statements. ### Logging interception -For log statements interception, this module exposes `captureLogData { ... }`. +For intercepting log statements, this module exposes `captureLogData { ... }`. This function uses `DynamicBackendFactory` to catch all `LogData` emitted during the execution of the passed `action`. diff --git a/dependencies.md b/dependencies.md index a120c7e2a..e9f5ea0da 100644 --- a/dependencies.md +++ b/dependencies.md @@ -1,6 +1,6 @@ -# Dependencies of `io.spine:spine-logging-fixtures:2.0.0-SNAPSHOT.258` +# Dependencies of `io.spine:spine-logging-fixtures:2.0.0-SNAPSHOT.259` ## Runtime ## Compile, tests, and tooling diff --git a/jvm/README.md b/jvm/README.md index 093e36886..1729e3ca5 100644 --- a/jvm/README.md +++ b/jvm/README.md @@ -38,12 +38,12 @@ For example: Potentially, we can have different `Platform` implementations for different Java platforms. And this module was meant to generate different `PlatformProvider` -classes on different platforms. But as for now, it always generates a provider +classes on different platforms. But as of now, it always generates a provider that creates instances of `DefaultPlatform`. In the future, this module may be replaced with a single hard class. -Take a look on issue [#67](https://github.com/SpineEventEngine/logging/issues/67) +Take a look at issue [#67](https://github.com/SpineEventEngine/logging/issues/67) for details. [flogger-github]: https://google.github.io/flogger diff --git a/logging/README.md b/logging/README.md index deac3fb21..b538b11d1 100644 --- a/logging/README.md +++ b/logging/README.md @@ -3,7 +3,7 @@ This module contains Spine Logging API. API and implementation are largely inspired by [Google Flogger][flogger] and -the introduction of fluent logging API in [SLF4J in v2.0.0][fluent-slf4j]. +the introduction of fluent logging API in [SLF4J v2.0.0][fluent-slf4j]. The library aims to be multiplatform, but as of now, only the JVM target is supported. diff --git a/pom.xml b/pom.xml index 3212c6f1f..52dd03388 100644 --- a/pom.xml +++ b/pom.xml @@ -10,7 +10,7 @@ all modules and does not describe the project structure per-subproject. --> io.spine spine-logging -2.0.0-SNAPSHOT.258 +2.0.0-SNAPSHOT.259 2015 diff --git a/tests/smoke-test/README.md b/tests/smoke-test/README.md index 66b17a597..c43c37af9 100644 --- a/tests/smoke-test/README.md +++ b/tests/smoke-test/README.md @@ -11,19 +11,19 @@ better to have some real-life check-ups outside the development repository. ### Applicability -As for now, it is only applicable to JVM modules. It is because testing involves usage -of JUL-based backend. This backend is default and allows to easier intercept the logged +As of now, it is only applicable to JVM modules. It is because testing involves usage +of JUL-based backend. This backend is default and allows easier interception of the logged text for further assertion. -Take a look on `AbstractLoggingSmokeTest` for usage example. +Take a look at `AbstractLoggingSmokeTest` for usage example. -Please note, presence of `spine-logging` and `spine-logging-backend` is expected due to -Gradle configuration of `jvm-module` script plugin, which is applied to Spine JVM modules. +Please note, the presence of `spine-logging` and `spine-logging-backend` is expected due to +the Gradle configuration of `jvm-module` script plugin, which is applied to Spine JVM modules. `spine-logging` should be added manually if this smoke test is used in a module without `jvm-module` configuration: ``` implementation("io.spine:spine-logging:$version") -runtimeOnly("io.spine:spine-logging-backend:$version) +runtimeOnly("io.spine:spine-logging-backend:$version") ``` diff --git a/version.gradle.kts b/version.gradle.kts index 5b8d86719..9d1f75711 100644 --- a/version.gradle.kts +++ b/version.gradle.kts @@ -24,4 +24,4 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -val versionToPublish: String by extra("2.0.0-SNAPSHOT.258") +val versionToPublish: String by extra("2.0.0-SNAPSHOT.259")