docs(contributing): add contributor guide#53
Open
FenjuFu wants to merge 1 commit into
Open
Conversation
Covers prerequisites, make targets for build/test/lint/vuln, the build-tagged integration tests, the one-way Channel -> Router -> Engine -> Provider/Tool layering, and points at docs/release-rules.md for commit and changelog rules.
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
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.
What
Adds a
CONTRIBUTING.md. The repository did not have one.Contents
go 1.26.1), plus the optionalgolangci-lintandripgrepdependenciesmake build/make run, and whymake runis preferred over calling the binary directly (it frees ports and prepares the runtime dir first)make fmt/tidy/lint/test/vuln, and the build-tagged integration tests that are deliberately excluded frommake testChannel -> Router -> Engine -> Provider / Tooldependency direction, plus a table pointing at the real extension pointsCo-Authored-BytrailersNotes
Paths were taken from the current tree, not from the README's "Project Structure" section - that section is stale (it lists
internal/tool/andinternal/skill/, the actual directories areinternal/tools/andinternal/skills/). Happy to fix the README separately if useful.Nothing is claimed about MCP:
internal/mcp/currently holds only a.gitkeep, so there is no behaviour to document yet.Docs-only change.