Skip to content

fix: remove dead CONTRIBUTING.md link, expand auth docs#54

Merged
KalebCole merged 1 commit intomainfrom
pieter/readme-fixes
Mar 30, 2026
Merged

fix: remove dead CONTRIBUTING.md link, expand auth docs#54
KalebCole merged 1 commit intomainfrom
pieter/readme-fixes

Conversation

@KalebCole
Copy link
Copy Markdown
Owner

@KalebCole KalebCole commented Mar 30, 2026

  • Contributing: replaced dead CONTRIBUTING.md link with inline dev setup instructions
  • Auth Setup: expanded to explain the full SMS flow — auto-retrieve via imsg on macOS, manual fallback on other platforms, creds stored at ~/.config/partiful/auth.json

Summary by CodeRabbit

  • Documentation
    • Added "How it works" section under Auth Setup detailing SMS verification flow, including phone format requirements, SMS delivery methods, macOS auto-retrieval options, and credential storage.
    • Enhanced Contributing section with inline development setup instructions.

- Contributing section: inline dev setup instead of linking nonexistent file
- Auth Setup: explain the SMS flow (auto-retrieve via imsg on macOS, manual fallback)
- Credentials stored at ~/.config/partiful/auth.json
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 30, 2026

📝 Walkthrough

Walkthrough

Documentation update to README.md adding a "How it works" section under Auth Setup that describes the SMS verification flow (E.164 phone input, SMS code delivery, optional macOS auto-retrieval via iMessage, manual fallback, and credential persistence) and replacing the Contributing section with inline development setup commands.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added "How it works" subsection under Auth Setup detailing SMS verification flow (E.164 format, SMS delivery, optional iMessage auto-retrieval, manual fallback, credential storage at ~/.config/partiful/auth.json). Replaced Contributing section pointer to external file with inline git clone, npm install, npm link, and npm test commands.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Poem

🐰 A docs jump so neat, with flows crystal clear,
SMS paths illuminated for all to revere,
From phone to the code, then saved with such care,
Contributing steps now living right there!
No mysteries here—just kindness to share. 📱✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: removing a dead link and expanding authentication documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch pieter/readme-fixes

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

183-189: Consider documenting the environment variable overrides.

While the documented flow is accurate, the code supports two additional authentication methods that advanced users might find useful:

  1. PARTIFUL_CREDENTIALS_FILE — override the default credentials path
  2. PARTIFUL_TOKEN — provide an access token directly, bypassing file-based auth

These are currently not mentioned in the README. As per context snippet 1 (src/lib/auth.js:12-37), loadConfig() and resolveCredentialsPath() support these env vars.

📝 Optional addition to document env var overrides

Add after line 188:

 5. Credentials are saved to `~/.config/partiful/auth.json`
+
+**Advanced:** Set `PARTIFUL_CREDENTIALS_FILE` to use a custom credentials path, or `PARTIFUL_TOKEN` to bypass file-based auth entirely.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 183 - 189, Update the README near the authentication
flow to document the two env var overrides supported by the code: mention
PARTIFUL_CREDENTIALS_FILE (overrides the default credentials path used by
resolveCredentialsPath()/loadConfig()) and PARTIFUL_TOKEN (directly provides an
access token to bypass file-based auth), and clarify their precedence/behavior
(i.e., PARTIFUL_TOKEN bypasses file loading, PARTIFUL_CREDENTIALS_FILE points
loadConfig() to an alternate path).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 186: Update the imsg repository URL in the README entry that currently
links to https://github.com/nicktomlin/imsg; change the link target for the
"imsg" reference to the correct repository URL https://github.com/steipete/imsg
so the README points to the proper CLI tool source.

---

Nitpick comments:
In `@README.md`:
- Around line 183-189: Update the README near the authentication flow to
document the two env var overrides supported by the code: mention
PARTIFUL_CREDENTIALS_FILE (overrides the default credentials path used by
resolveCredentialsPath()/loadConfig()) and PARTIFUL_TOKEN (directly provides an
access token to bypass file-based auth), and clarify their precedence/behavior
(i.e., PARTIFUL_TOKEN bypasses file loading, PARTIFUL_CREDENTIALS_FILE points
loadConfig() to an alternate path).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6f2def43-3171-48bf-abbb-999a6c61759a

📥 Commits

Reviewing files that changed from the base of the PR and between c1519fc and a38a54f.

📒 Files selected for processing (1)
  • README.md

**How it works:**
1. You provide your phone number (E.164 format, e.g. `+12065551234`)
2. Partiful sends an SMS verification code to that number
3. On macOS with [`imsg`](https://github.com/nicktomlin/imsg) installed, the code is auto-retrieved from Messages
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🌐 Web query:

What is the correct GitHub repository URL for the imsg command-line tool for macOS Messages?

💡 Result:

The correct GitHub repository URL for the imsg command-line tool for macOS Messages is https://github.com/steipete/imsg.

Citations:


Update the imsg repository URL in line 186.

The linked repository is incorrect. The imsg CLI tool is located at https://github.com/steipete/imsg, not https://github.com/nicktomlin/imsg.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 186, Update the imsg repository URL in the README entry
that currently links to https://github.com/nicktomlin/imsg; change the link
target for the "imsg" reference to the correct repository URL
https://github.com/steipete/imsg so the README points to the proper CLI tool
source.

@KalebCole KalebCole merged commit 51ff08d into main Mar 30, 2026
1 check passed
@KalebCole KalebCole deleted the pieter/readme-fixes branch March 30, 2026 00:43
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