docs: add CONTRIBUTING.md, fix Makefile, and improve .gitignore#30
Open
Dakshx07 wants to merge 1 commit into
Open
docs: add CONTRIBUTING.md, fix Makefile, and improve .gitignore#30Dakshx07 wants to merge 1 commit into
Dakshx07 wants to merge 1 commit into
Conversation
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.
📝 Overview
This PR significantly improves the Developer Experience (DX) for new contributors. While setting up the project, I identified several "friction points" that could discourage new developers. This contribution solves those issues at the foundation.
🛠️ Key Improvements
1. New
CONTRIBUTING.mdAdded a comprehensive guide for new developers.
Makefile.2. Makefile Logic Fixes
make installwould fail because it attempted to enter a non-existentsandman/directory.pty-devto theinstalltarget. This ensures that the Rust-based terminal engine is built automatically during the initial setup.3. Repository Hygiene (
.gitignore).gitignoreto recursively ignorenode_modules/.📸 Visual Proof
Before (Build Failure)
Caution
make installfails with/bin/sh: line 0: cd: sandman: No such file or directoryAfter (Successful Setup)
Tip
make installnow completes all tasks across the monorepo in one go.🏁 Final Check
make installon local machineCONTRIBUTING.mdformatting