Skip to content

docs(contributing): add a contributing guide with the local stack setup - #83

Open
Diubii wants to merge 3 commits into
mainfrom
docs/contributing
Open

Diubii wants to merge 3 commits into
mainfrom
docs/contributing

Conversation

@Diubii

@Diubii Diubii commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Adds CONTRIBUTING.md: prerequisites (Docker, Vite+), Auth on its own with the dev personas, everyday commands and PR rules.
  • Its Connect the local stack section is the shared part the backend and admin guides link to: the two resource identifiers, generating the backend's Ed25519 key pair, and registering the backend (idp:access:read, idp:people:roles) and the admin dashboard (client secret, backend:admin) in /applications.
  • The local port is now 3003 everywhere: vp run dev serves Auth there (the backend uses 3000), but the README and the env examples still said 3000.

Companion PRs: PoliNetworkOrg/backend (CONTRIBUTING.md + compose.yaml) and PoliNetworkOrg/admin (CONTRIBUTING.md + compose.yaml for its Redis).

Test plan

  • vp check
  • Follow the guide on a clean checkout and sign in to the local dashboard

🤖 Generated with Claude Code

CONTRIBUTING.md sets up Auth on its own with the dev personas, and connects it to a local
backend and admin dashboard: resource identifiers, the backend's key pair, and the two
applications to register. The local port is 3003, as `vp run dev` serves it, so the README
and the env examples now say so too.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: PoliNetworkOrg/auth
  • Branch: main
  • File: .coderabbit.yaml
  • Commit: 9fe232e
  • Layers: Repository YAML (base), Organization UI (inherited)
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 6b474a26-23f1-441b-b4fc-9b9a25f2ae76
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@Diubii
Diubii marked this pull request as draft November 7, 2026 23:19
@Diubii
Diubii marked this pull request as ready for review November 15, 2026 19:12
@Diubii
Diubii marked this pull request as draft November 15, 2026 23:13
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Diubii
Diubii marked this pull request as ready for review November 15, 2026 23:17
@Diubii Diubii changed the title docs: add a contributing guide with the local stack setup docs(contributing): add a contributing guide with the local stack setup Nov 17, 2026
@Diubii
Diubii requested a review from a team November 17, 2026 17:11
@Diubii Diubii self-assigned this Nov 17, 2026
@Diubii

Diubii commented Nov 17, 2026

Copy link
Copy Markdown
Contributor Author

Ready to be merged

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