Repository navigation
docs: adapt contributor guidance and repository policies for Whale - #210
Merged
LunaStev merged 1 commit intoSep 22, 2026
Merged
Conversation
Document Whale-specific setup, crate ownership, signed-off contributions, validation, focused formatting, and PR branch updates. Add the contributor policy documents and a Whale-specific pull request template, with README navigation to the guidance. Adapt policy text from wavefnd/Wave at ff9f98941bf09574f89377dfac84e4f267324bce. Preserve the AI policy body and Contributor Covenant attribution. Keep Whale's existing MPL-2.0 license, implementation, issue templates, funding configuration, and CI unchanged. Signed-off-by: LunaStev <luna@lunastev.org>
5 tasks
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
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
Adapt the contributor-facing documentation and policy structure from Wave to Whale, in one documentation-only commit based on upstream
eeb17f1.CONTRIBUTING.mdwith Whale's crate map, fork/branch workflow, signed-off commits, email patch routing, actual default/all-features checks, regression expectations, and review follow-up.MAINTAINERS,COPYRIGHT,NOTICE,CODE_OF_CONDUCT.md, andai.txt..github/PULL_REQUEST_TEMPLATE.mdwith Whale-specific compatibility and validation prompts, and a short contributor navigation section inREADME.md.Motivation
Contributors need one entry point that describes this repository rather than Wave's compiler environment. The guide uses Whale's existing CI and component structure; it does not require Wave's LLVM SDK, standard-library policy checks, or maintainer helper scripts that Whale does not have.
Reference: Wave contributor and policy files at ff9f9894.
Target and compatibility impact
No runtime, assembly, object format, IR, CLI, dependency, feature, or MSRV changes.
Whale's existing
LICENSEis unchanged. The copyright/notice documents describe Whale's MPL-2.0 repository, without copying Wave's separate standard-library license split. The AI policy retains Wave's complete policy body and 30 language notices, changing only the project heading and update date. The Code of Conduct preserves the existing Contributor Covenant text and attribution, scopes it to Whale, and uses the maintainer email listed in Wave's currentMAINTAINERS.Implementation files, tests,
.github/workflows/,.github/ISSUE_TEMPLATE/, and funding configuration are unchanged. No issue-closing directive is included.Validation
Local documentation checks on the exact contents uploaded through the GitHub connector:
MAINTAINERSfile/directory entries against the fetched repository tree and new files.bash -non 12 shell examples; this is syntax validation, not execution of the documented commands.Rust build, tests, Clippy, and rustdoc were not run locally because this editing environment has no Rust toolchain. This PR changes prose and a Markdown PR template only; existing CI remains responsible for its normal checks.
Checklist
Signed-off-byline and preserves attribution.