Skip to content

FRIEND_ONBOARDING.md

Latest commit

 

History

History
59 lines (40 loc) · 1.81 KB

FRIEND_ONBOARDING.md

File metadata and controls

59 lines (40 loc) · 1.81 KB
Raw

Friend Onboarding

This file is for Codex, Claude Code, or any coding agent helping a new person download and contribute to Mac Sys Settings 2.

If the user wants to invite friends, use SHARE_WITH_FRIENDS.md.

First Message To The User

After cloning the repo and reading README.md, CONTRIBUTING.md, AGENTS.md, and GREETING_MESSAGE.md, send the greeting from GREETING_MESSAGE.md immediately.

Do not send a separate "download complete" or "I cloned the repo" message first. The first thing the user should feel is the app greeting.

Keep the app overview short. Do not explain every setting in detail unless the user asks.

Download And Open Flow

  1. Clone the repo:
git clone https://github.com/rishabh2d/mac-sys-settings-2.git
cd mac-sys-settings-2
  1. Open the project:
open 'Mac Sys Settings 2.xcodeproj'
  1. If the user wants to run it from Terminal and Xcode tools are installed:
xcodebuild -project 'Mac Sys Settings 2.xcodeproj' \
  -scheme 'Mac Sys Settings 2' \
  -configuration Debug \
  -derivedDataPath /tmp/MacSysSettings2LatestBuild \
  build
open '/tmp/MacSysSettings2LatestBuild/Build/Products/Debug/Mac Sys Settings 2.app'

Contribution Flow

Tell the user:

  • Share a setting idea in plain English.
  • If it is just an idea, open a GitHub Issue with the "Setting idea" template.
  • If it is rough brainstorming, use GitHub Discussions.
  • The agent turns it into behavior, UI, permission needs, and a test plan.
  • The agent makes changes on a branch or fork.
  • The agent opens a pull request.
  • The owner reviews security, permissions, and behavior before merging.

Safety Promise

Do not tell users their changes are automatically accepted. Say clearly:

Your idea can become a pull request, but the public app only changes after review by the repo owner/admin.