Skip to content

Add AGENTS.md contributor guide and development/testing conventions#306

Merged
ggrell merged 1 commit intomainfrom
codex/explain-codebase-structure-and-key-concepts
Mar 1, 2026
Merged

Add AGENTS.md contributor guide and development/testing conventions#306
ggrell merged 1 commit intomainfrom
codex/explain-codebase-structure-and-key-concepts

Conversation

@ggrell
Copy link
Owner

@ggrell ggrell commented Mar 1, 2026

Motivation

  • Add a newcomer and contributor guide to centralize repository overview, development workflow, and testing/style expectations for the RxReactor project.

Description

  • Add AGENTS.md documenting repository structure, core concepts like Reactor/ReactorWithEffects/SimpleReactor, and the recommended learning path.
  • Document development and code-style expectations including Detekt rules and Kotlin idioms, and include a BSD-3-Clause file header template for new files.
  • Provide explicit unit test guidance covering frameworks (JUnit 4), RxJava TestObserver, assertion preferences, test placement across rxreactor1/rxreactor2/rxreactor3, and when to run ./gradlew check.
  • Include CI/workflow references and instructions for running targeted module tests during development.

Testing

  • No automated tests were added or modified as part of this documentation-only change.
  • Recommend running ./gradlew check locally and relying on existing CI workflows to validate formatting, static analysis, and tests.

Codex Task

@codecov
Copy link

codecov bot commented Mar 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.11%. Comparing base (a04b900) to head (b40e596).
⚠️ Report is 14 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##               main     #306   +/-   ##
=========================================
  Coverage     88.11%   88.11%           
  Complexity       48       48           
=========================================
  Files             9        9           
  Lines           101      101           
=========================================
  Hits             89       89           
  Misses           12       12           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d8976ea...b40e596. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ggrell ggrell enabled auto-merge March 1, 2026 20:38
@ggrell ggrell force-pushed the codex/explain-codebase-structure-and-key-concepts branch from 51a28b6 to b40e596 Compare March 1, 2026 20:38
@ggrell ggrell disabled auto-merge March 1, 2026 21:32
@ggrell ggrell merged commit da2befd into main Mar 1, 2026
5 checks passed
@ggrell ggrell deleted the codex/explain-codebase-structure-and-key-concepts branch March 1, 2026 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant