Skip to content

Commit 52c8279

Browse files
committed
Document primer usage and dependency lookup in AGENTS.md
1 parent 559c9ff commit 52c8279

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,14 @@ Changes may also include fixing merge conflicts.
207207

208208
IMPORTANT: Some changes may be non-trivial,
209209
for which you can find detail background information for each seperate Minecraft update within these primers: https://github.com/neoforged/.github/tree/main/primers
210+
You can use these primers to learn how certain classes or systems were changed across Minecraft versions.
211+
Since primers can be quite large, download them first, and then use grep on the downloaded file to find information related to a relevant class or system.
210212
The blogs of https://neoforged.net/ and https://fabricmc.net/blog/ may also contain useful porting help.
211213

212214
After making all necessary changes, make sure the code fully compiles and the (game) tests pass.
215+
216+
## Finding code in dependencies
217+
218+
When searching for dependencies in `~/.gradle`, take into account that this directory may be very large,
219+
so make sure that lookups are as selective as possible (name, version, ...) to avoid slow lookups.
220+
When possible, lookup the relevant jar first, and only then look for specific classes within that jar.

0 commit comments

Comments
 (0)