Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (67 loc) · 6.26 KB

CONTRIBUTING.md

File metadata and controls

96 lines (67 loc) · 6.26 KB

Contributing to the Greenpill Dev Guild

Welcome! We're glad you're here. This guide covers how to get involved, claim bounties, and ship work that meets guild standards across our projects.

Table of contents

Getting started

  1. Join our community. Engage with us on Telegram and Discord to stay updated and ask questions.
  2. Familiarize yourself with our projects. Browse the active repositories pinned on our org page — green-goods, coop, cookie-jar, network-website are the flagship surfaces.
  3. Read the Code of Conduct. Required for all contributors.
  4. Skim the routines/ directory if you're new to the guild — short markdown playbooks for our recurring flows (bounty intake, weekly check-ins, onboarding, retros).

Bounty flow

The guild operates on a bounty model. End to end:

  1. Find a bounty in the guild workspace at greenpill.app/dev-guild (coming soon — currently on Charmverse during migration).
  2. Submit an application with a timeline and technical context. Include relevant prior work, expected scope, and any open questions.
  3. Receive a development stipend on acceptance to begin work.
  4. Check in weekly — short 15-minute updates to report progress and surface blockers. Stay aligned with the guild's coding standards and security practices.
  5. Submit your work — open a PR on the relevant repo, link to the bounty, and request review (see below).
  6. Final approval and payout — once approved, the remainder is paid via Optimism within 2 business days.

Detailed walkthrough: routines/bounty-intake.md.

Development guidelines

These apply across all guild projects. Project-specific AGENTS.md / CLAUDE.md / CONTRIBUTING.md files extend or override.

  • Open source only — all code and dependencies must be open-source-licensed.
  • Test what you ship — unit tests for new logic, integration tests for cross-package flows, and E2E for user-facing journeys where they exist.
  • Documented contributions — at minimum, a clear PR description; substantive changes warrant updates to the project's docs.
  • Conventional Commits — most projects use type(scope): description (e.g. feat(green-goods): add garden filter). Check the project's CONTRIBUTING.md for the exact convention.
  • Bun-forward — newer guild projects standardize on Bun as the JavaScript runtime and package manager. If you're scaffolding something new, default to Bun unless there's a specific reason not to.
  • Security best practices — never commit secrets, validate inputs at system boundaries, follow the Security Policy.

Submitting your work

  1. Branch naming — type/short-description (e.g. feature/hats-v2, bug/admin-fix). Match the project's existing convention.
  2. Pull requests — use the project's PR template; link to the bounty issue; describe what changed and why; include a test plan.
  3. CI must pass — formatting, linting, tests, and build checks must be green before requesting review.
  4. One bounty, one PR where reasonable — long-running work can be split, but coordinate with the maintainer first.
  5. For design work — submit via Figma or the project's design tool, link from the PR description, and notify the project's design lead.

Review process

  • Maintainer review — project maintainers review for correctness, scope adherence, test coverage, and security.
  • Feedback — if revisions are needed, you'll get a clear list. Address them and request re-review.
  • Approval — once approved and CI is green, the maintainer merges. For high-risk paths (deploy scripts, contracts, security-sensitive code), an additional steward review may be required.

Payment and completion

  • Approval — once your work is merged and the bounty is marked complete in the guild workspace, the final payment is queued.
  • Payment method — payments are made via Optimism within 2 business days of final approval.
  • Total compensation — your bounty payout combines the initial development stipend and the remainder paid on completion.

Agentic development

Many guild contributors work with AI coding assistants (Claude Code, Codex, Copilot). The guild publishes shared baselines so this works smoothly:

  • Templates at templates/ — copy-into-repo starters for CLAUDE.md, AGENTS.md, and copilot-instructions.md if your project doesn't have them yet.
  • Org defaults — community-health files and issue/PR templates in this repo propagate to guild repos unless overridden locally.
  • Copilot instructions — use the template here to create a project-local .github/copilot-instructions.md, or configure organization-level Copilot instructions in GitHub settings.
  • Reusable workflows — opt-in building blocks such as labels sync and non-blocking Claude PR review that any guild repo can call explicitly.

If you're using an AI assistant on guild code, treat it like any other contributor: it's bound by these guidelines, the project's CLAUDE.md / AGENTS.md, and the Code of Conduct.

Resources

Code of Conduct

Please read and adhere to our Code of Conduct to keep our community welcoming, inclusive, and productive.

Thank you for contributing to the Greenpill Dev Guild — we're excited to build with you.