docs: fix the contributor setup instructions - #139
Open
0xrlawrence wants to merge 1 commit into
Open
Conversation
Four things in the setup section either do not work or contradict the repo. - The clone command is `git clone .../your-username/orbinum-node.git` followed by `cd orbinum-node`. The repository is named `node`, so both the URL and the directory are wrong and the very first step of the guide fails. Also added the upstream remote, since the section is headed "Fork the repository" and a fork without one cannot be kept in sync. - Requirements say "Rust 1.75+ (specified in rust-toolchain.toml)". rust-toolchain.toml pins `channel = "1.88.0"`, which is not a minimum and not 1.75. The practical point is that a contributor does not choose a version at all: rustup reads the pin and fetches the toolchain, the wasm32v1-none target and the listed components. Said that instead. - The system packages are missing entirely. CI installs build-essential, clang, libclang-dev and protobuf-compiler before it builds, and the build fails without them. Following the guide as written on a clean machine does not get you a build. - Steps 2 and 4 use bare cargo commands that do not match what CI runs, and the Makefile is only mentioned once, in the last step. Pointed the steps at the Makefile targets so a green local run means a green CI run, and referenced `make help` for the rest. Also noted the disk requirement. A full workspace build needs roughly 40 GB, which is worth knowing before starting rather than after running out partway through. Documentation only. Note: this touches CONTRIBUTING.md, as does orbinum#135. The two edit different sections and should merge cleanly in either order, but flagging it in case you take one and not the other. Co-Authored-By: Claude Opus 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.
Four things in the "Setting up your Environment" section either do not work or contradict the repository.
The clone command is wrong. It says
git clone https://github.com/your-username/orbinum-node.gitfollowed bycd orbinum-node. The repository is namednode, so both the URL and the directory are wrong and step 1 of the guide fails outright. I also added the upstream remote, since the section is headed "Fork the repository" and a fork without one cannot be kept in sync.The Rust version is wrong. Requirements say "Rust 1.75+ (specified in
rust-toolchain.toml)". That file pinschannel = "1.88.0", which is neither a minimum nor 1.75. The practical point is that a contributor does not pick a version at all: rustup reads the pin and fetches the toolchain, thewasm32v1-nonetarget, and the listed components. Rewrote it to say that.The system packages are missing entirely. CI installs
build-essential clang libclang-dev protobuf-compilerbefore building, and the build fails without them. Following the guide as written on a clean machine does not get you a build, and theprotobuf-compilerfailure in particular arrives late, after a long compile.The steps do not match CI. Steps 2 and 4 use bare cargo commands, while the Makefile, which carries the feature flags and profile CI actually uses, is mentioned once in the last step. Pointed the steps at
make setup,make build-release,make test-release,make clippy-releaseandmake fmt-check, so a green local run means a green CI run, and referencedmake helpfor the rest.Also noted the disk requirement. A full workspace build wants somewhere around 40 GB, which is better known before starting than discovered partway through. Adjust the figure if you have a better one; mine is an estimate from a partial build.
Verification
Documentation only. Every claim is checked against something in the repo: the repository name,
rust-toolchain.toml, theapt-get installline in.github/workflows/test.yml, and the target list in theMakefile. I confirmedscripts/setup-dev.shexists and left that step as it was.Note
This touches
CONTRIBUTING.md, as does #135. The two edit different sections and should merge cleanly in either order, but flagging it in case you take one and not the other.Separately, I have emailed
security@orbinum.netabout a number of higher-severity findings from the same review pass. Those are deliberately not in this PR, in any other PR, or in a public issue.