docs: add CONTRIBUTING.md - #717
Merged
Merged
Conversation
Build setup, PR conventions derived from existing history, and the two gotchas that repeatedly bite contributors: the unconditional engine link list that breaks the HRX build when a model lands only in lib/xrt/, and new docs pages being invisible until added to docs_nav. Co-Authored-By: Claude <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
2 participants
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
Adds a
CONTRIBUTING.md— the repo had no contributing, code-of-conduct, or PR/issue template files before this.Kept deliberately short (57 lines). It only documents things a contributor cannot work out from the tree on their own; build prerequisites already covered in the README are not repeated.
Contents
The two gotchas called out
Adding a model needs an engine library for both NPU backends. The engine link list in
CMakeLists.txtis unconditional, so an engine that lands only insrc/lib/xrt/breaks theFLM_USE_HRX=ONbuild at link time while the default build stays green. This happened between 2026-08-26 and 2026-09-07 withgemma4_12b_npuandhunyuan_npu.A new docs page is invisible until added to
docs_navindocs/_config.yml— the sidebar is not generated from page front matter.Notes
Commit conventions were derived from actual history (last 300 non-merge commits:
feat:148,docs:36,fix:34,chore:25,ci:13,refactor:9), including the scoped forms in use (chore(hrx):,fix(portable):) and the absence of sign-offs.All referenced paths and links were verified to resolve.
Docs-only change — no source, build, or packaging files touched.
🤖 Generated with Claude Code