Add AGENTS.md, ARCHITECTURE.md, and CONTRIBUTING.md - #338
Merged
Merged
Conversation
Documents the plugin scaffold's branch model, Gephi's SPI/Lookup extension mechanism, and Gephi platform conventions (logging, localization, preferences, library wrapper modules, icons, test utilities) so contributors and AI agents can build and review plugins consistently. .claude/CLAUDE.md points to AGENTS.md, and README.md's former "Best practices" section now points to CONTRIBUTING.md instead of duplicating it. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
3 tasks
mbastian
added a commit
that referenced
this pull request
Sep 20, 2026
* Fix CI validation for PRs targeting master master has no plugin modules of its own, so build.yml's build_and_test job hard-fails on scaffold-only PRs (e.g. #338) with "No 'nbm' modules have been detected." It also never ran at all for fork-based PRs, since push events don't fire cross-fork and master had no pull_request trigger. - build.yml: skip build/validate gracefully when pom.xml has no <module> entries instead of failing. - test-generation.yml: add a pull_request trigger for master so PRs (same-repo or fork) get the generation integration test run pre-merge, mirroring master-forge's pr.yml. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * Fix build.yml module check to ignore pom.xml's example comment grep -q '<module>' pom.xml matched the placeholder comment (<!-- ... e.g. <module>modules/MyModule</module> ... -->) in the empty <modules> block, so the skip never actually triggered. Check for real module directories under modules/ instead. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AGENTS.md— instructions for AI coding agents: build/test commands, adding/changing a plugin, code style, and PR guidelines including a checklist for reviewing third-party plugin PRs.ARCHITECTURE.md— the repo's three-branch model (master/master-forge/parent-pom), Gephi's SPI/Lookup extension mechanism, plugin module anatomy, and thegephi-maven-pluginbuild lifecycle.CONTRIBUTING.md— code-quality expectations, a "Reviewing a plugin submission PR" checklist derived from real recurring gaps in past submissions, and a "Gephi platform conventions" section (logging, localization, preferences, library wrapper modules, icons, suite naming, test utilities, comments) grounded in real examples from the core Gephi codebase..claude/CLAUDE.mdpointing toAGENTS.md.README.md's "Best practices" section to point toCONTRIBUTING.mdinstead of duplicating it.Test plan
CONTRIBUTING.mdsections🤖 Generated with Claude Code