chore: verify clippy -D warnings, add MSRV matrix, branch-protection docs, and Makefile shortcuts - #174
Open
Lost-Z wants to merge 1 commit into
Conversation
…docs, and Makefile shortcuts - ci.yml: add Rust 1.78 MSRV matrix leg alongside stable so the declared prerequisite (README: 'Rust 1.78+') is actually verified in CI (closes stellar-vortex-protocol#99). The clippy step runs 'cargo clippy --all-targets -- -D warnings' on every matrix leg, identical to README's documented command (closes stellar-vortex-protocol#95). rustfmt check is restricted to the stable leg to avoid false failures. - CONTRIBUTING.md: new file covering contributor workflow and a maintainer guide that enumerates required CI checks, explains how to verify them in the GitHub branch-protection UI and via the GitHub CLI, and documents the policy for updating required checks when new jobs are added (closes stellar-vortex-protocol#100, closes stellar-vortex-protocol#95). - Makefile + justfile: wrap all README-documented commands as named targets (fmt, lint, test, build, audit, clean, deploy-testnet) so contributors do not need to copy-paste raw multi-flag commands (closes stellar-vortex-protocol#101). - README.md: expand Build & Test section to reference Makefile/justfile shortcuts alongside the existing raw commands; update Contributing link to point at the new local CONTRIBUTING.md (closes stellar-vortex-protocol#101).
|
@Lost-Z Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
This PR implements four related CI/tooling issues in one cohesive change.
Closes #95 — Verify clippy
-D warningsis enforced as a required CI status check.github/workflows/ci.yml: theClippystep already runs the exact command documented in README (cargo clippy --all-targets -- -D warnings). No drift found.-D warningsis now enforced on bothstableand1.78legs.CONTRIBUTING.md(new) includes a dedicated section explaining how maintainers can verify the required-check is actually enforced via the GitHub UI and GitHub CLI.Closes #99 — Add a CI matrix testing against the README's stated MSRV (Rust 1.78+)
"1.78"to thecontractjob matrix alongsidestable.rustfmtcheck is intentionally restricted to thestableleg to avoid false failures from formatter output changes across Rust versions.Closes #100 — Add branch protection / required-checks documentation for maintainers
CONTRIBUTING.mdwith a Maintainer Guide section that:Contract (stable),Contract (1.78),Dependency audit).gh apiCLI command for scripted verification.Closes #101 — Add a Makefile/justfile wrapping the README's build/test/deploy commands
Makefilewith targets:fmt,fmt-check,lint,test,build,audit,clean,deploy-testnet,all,help.justfilefor users ofjust.deploy-testnetrequiresSTELLAR_SOURCEto be set and errors clearly if it isn't.README.mdBuild & Test section to showcase shortcut commands alongside raw commands.CONTRIBUTING.md.What was tested
No build/test run was performed per task instructions. CI will validate on this PR:
Contract (stable)— fmt, clippy, test, wasm buildContract (1.78)— clippy, test, wasm build (new MSRV leg)Dependency audit