Skip to content

docs: add CONTRIBUTING.md, fix Makefile, and improve .gitignore#30

Open
Dakshx07 wants to merge 1 commit into
lunel-dev:mainfrom
Dakshx07:docs/add-contributing-guide
Open

docs: add CONTRIBUTING.md, fix Makefile, and improve .gitignore#30
Dakshx07 wants to merge 1 commit into
lunel-dev:mainfrom
Dakshx07:docs/add-contributing-guide

Conversation

@Dakshx07
Copy link
Copy Markdown

📝 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.md

Added a comprehensive guide for new developers.

  • Lists all polyglot prerequisites (Bun, Rust, Go).
  • Explains the monorepo structure (App vs Engine).
  • Provides a clear Quick Start using the Makefile.

2. Makefile Logic Fixes

  • Resolved Build Crash: Fixed a bug where make install would fail because it attempted to enter a non-existent sandman/ directory.
  • Improved Installation Flow: Added pty-dev to the install target. This ensures that the Rust-based terminal engine is built automatically during the initial setup.

3. Repository Hygiene (.gitignore)

  • Optimized the root .gitignore to recursively ignore node_modules/.
  • This prevents noise in source control and keeps the repo clean.

📸 Visual Proof

Before (Build Failure)

Caution

make install fails with /bin/sh: line 0: cd: sandman: No such file or directory

Screenshot 2026-05-12 at 7 56 50 PM

After (Successful Setup)

Tip

make install now completes all tasks across the monorepo in one go.

Screenshot 2026-05-12 at 7 57 42 PM

🏁 Final Check

  • Tested make install on local machine
  • Verified CONTRIBUTING.md formatting
  • Confirmed no unnecessary files are being tracked by Git

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant