You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@parquet.apache.org by "nastra (via GitHub)" <gi...@apache.org> on 2026/08/17 05:39:44 UTC
[PR] Add AGENTS.md with AssertJ/JUnit5 test migration guidelines [parquet-java]
nastra opened a new pull request, #3728:
URL: https://github.com/apache/parquet-java/pull/3728
<!--
Thanks for opening a pull request!
If you're new to Parquet-Java, information on how to contribute can be found here: https://parquet.apache.org/docs/contribution-guidelines/contributing
Please open a GitHub issue for this pull request: https://github.com/apache/parquet-java/issues/new/choose
and format pull request title as below:
GH-${GITHUB_ISSUE_ID}: ${SUMMARY}
or simply use the title below if it is a minor issue:
MINOR: ${SUMMARY}
-->
### Rationale for this change
This adds guidelines that I've been defining/using for Claude when migrating the entire codebase from JUnit4 to JUnit5 + AssertJ
### What changes are included in this PR?
An AGENTS.md file that contains migration guidelines
### Are these changes tested?
### Are there any user-facing changes?
<!-- Please uncomment the line below and replace ${GITHUB_ISSUE_ID} with the actual Github issue id. -->
<!-- Closes #${GITHUB_ISSUE_ID} -->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For additional commands, e-mail: issues-help@parquet.apache.org
Re: [PR] Add AGENTS.md with AssertJ/JUnit5 test migration guidelines [parquet-java]
Posted by "nastra (via GitHub)" <gi...@apache.org>.
nastra commented on code in PR #3728:
URL: https://github.com/apache/parquet-java/pull/3728#discussion_r3794107967
##########
AGENTS.md:
##########
@@ -0,0 +1,923 @@
+# AssertJ test migration rules
Review Comment:
oops yes, this needs a license header. added one
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For additional commands, e-mail: issues-help@parquet.apache.org
Re: [PR] Add AGENTS.md with AssertJ/JUnit5 test migration guidelines [parquet-java]
Posted by "nastra (via GitHub)" <gi...@apache.org>.
nastra commented on PR #3728:
URL: https://github.com/apache/parquet-java/pull/3728#issuecomment-5312286790
/cc @Fokko @wgtmac
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For additional commands, e-mail: issues-help@parquet.apache.org
Re: [PR] Add AGENTS.md with AssertJ/JUnit5 test migration guidelines [parquet-java]
Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko merged PR #3728:
URL: https://github.com/apache/parquet-java/pull/3728
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For additional commands, e-mail: issues-help@parquet.apache.org
Re: [PR] Add AGENTS.md with AssertJ/JUnit5 test migration guidelines [parquet-java]
Posted by "dossett (via GitHub)" <gi...@apache.org>.
dossett commented on PR #3728:
URL: https://github.com/apache/parquet-java/pull/3728#issuecomment-5318258940
I'm glad to see an AGENTS.md file added, this is great. This is a LOT of context about writing unit tests, which is also great. But it might be too much context for the agent to always have, even when doing things not related to unit tests. A pattern I've found very useful is to create some agent-specific documentation in a separate file and add a pointer to that in AGENTS.md. Then the agent always has the context of where to find the information when it needs it.
```
## Unit tests
When writing, updating, or migrating unit tests please read the reference document [e.g., `./agents/docs/unit-testing.md`]
```
Something like that
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For additional commands, e-mail: issues-help@parquet.apache.org
Re: [PR] Add AGENTS.md with AssertJ/JUnit5 test migration guidelines [parquet-java]
Posted by "nastra (via GitHub)" <gi...@apache.org>.
nastra commented on PR #3728:
URL: https://github.com/apache/parquet-java/pull/3728#issuecomment-5580381849
@wgtmac @Fokko can you guys please take another look at this?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For additional commands, e-mail: issues-help@parquet.apache.org
Re: [PR] Add AGENTS.md with AssertJ/JUnit5 test migration guidelines [parquet-java]
Posted by "divjotarora (via GitHub)" <gi...@apache.org>.
divjotarora commented on code in PR #3728:
URL: https://github.com/apache/parquet-java/pull/3728#discussion_r3907667875
##########
AGENTS.md:
##########
Review Comment:
I agree with @dossett that this is likely too much testing-specific info in a top-level `AGENTS.md`. The suggestion to move it to a separate file that can lazy loaded only when writing tests sounds reasonable. Additionally, we're mixing a lot of information about writing new tests vs. migrating existing ones. Perhaps it would make sense to separate these? Even if all of this info goes into a `TESTING_GUIDELINES.md` file or something but in separate sections, it would be more readable.
Lastly, there's a few "MUST" rules in here (e.g. every `assertThatThrownBy` must contain an `isInstanceOf` chain + msg check). Do we have linter rules for these rather than just putting them in agent guidelines?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For additional commands, e-mail: issues-help@parquet.apache.org
Re: [PR] Add AGENTS.md with AssertJ/JUnit5 test migration guidelines [parquet-java]
Posted by "wgtmac (via GitHub)" <gi...@apache.org>.
wgtmac commented on code in PR #3728:
URL: https://github.com/apache/parquet-java/pull/3728#discussion_r3794069056
##########
AGENTS.md:
##########
@@ -0,0 +1,923 @@
+# AssertJ test migration rules
Review Comment:
Do we need to add license header or add a RAT rule to exclude this file?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For additional commands, e-mail: issues-help@parquet.apache.org
Re: [PR] Add AGENTS.md with AssertJ/JUnit5 test migration guidelines [parquet-java]
Posted by "nastra (via GitHub)" <gi...@apache.org>.
nastra commented on code in PR #3728:
URL: https://github.com/apache/parquet-java/pull/3728#discussion_r3954990707
##########
AGENTS.md:
##########
Review Comment:
I've updated this and moved things into separate files, which are referenced from the main AGENTS.md.
> Lastly, there's a few "MUST" rules in here (e.g. every assertThatThrownBy must contain an isInstanceOf chain + msg check). Do we have linter rules for these rather than just putting them in agent guidelines?
The project doesn't have a linter that would be able to enforce this unfortunately
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For additional commands, e-mail: issues-help@parquet.apache.org
Re: [PR] Add AGENTS.md with AssertJ/JUnit5 test migration guidelines [parquet-java]
Posted by "dossett (via GitHub)" <gi...@apache.org>.
dossett commented on PR #3728:
URL: https://github.com/apache/parquet-java/pull/3728#issuecomment-5588681332
Thank you @nastra, love the split out. It will be exciting to have a top level AGENTS.md file that we can start to shape.
One additional request: symlinking this to CLAUDE.md can be helpful for Claude Code users.
reference: https://code.claude.com/docs/en/memory#agents-md
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@parquet.apache.org
For additional commands, e-mail: issues-help@parquet.apache.org