Skip to content

[DX] Expand CONTRIBUTING.md — full setup guide, PR checklist, issue templates #19

Open

Description

@Williams-1604

Overview

CONTRIBUTING.md needs to be complete enough that a contributor can go from zero to PR without asking for help.

What needs to be done

CONTRIBUTING.md

  • Full prerequisites with install commands
  • Step-by-step local setup (contract, frontend, backend)
  • Running the test suite for each layer
  • Code style guide (ESLint/Prettier + `cargo fmt` / `cargo clippy`)
  • PR checklist: tests added, lint passes, explains why not what
  • Conventional commit format

Issue templates (`.github/ISSUE_TEMPLATE/`)

  • `bug_report.yml`
  • `feature_request.yml`
  • `contract_issue.yml` — affected function, security implications

PR template (`.github/pull_request_template.md`)

Acceptance criteria

  • New contributor can set up from CONTRIBUTING.md alone
  • Issue templates render on GitHub
  • PR template prompts for test evidence

Activity

  1. added
    dxDeveloper experience improvements
    good first issueAccessible to verified senior contributors new to this codebase
    on May 18, 2026
  2. leo1987820 commented on Jun 24, 2026

    @leo1987820

    /attempt

    I can work on the DX documentation scope: expand CONTRIBUTING.md with setup/test/style/PR guidance, add GitHub issue templates, and add a PR template that asks for test evidence.

  3. temi-Dee commented on Jul 16, 2026

    @temi-Dee

    Hi maintainer i can work on this issues

  4. feliram09 commented on Jul 19, 2026

    @feliram09

    Hi! I'd like to work on this issue. My plan is to expand CONTRIBUTING.md with full prerequisites and install commands, step-by-step local setup for the contract, frontend, and backend layers, test-suite instructions for each, and a code style section (ESLint/Prettier plus cargo fmt/clippy). I'll also add a PR checklist covering tests, lint, and rationale, adopt conventional commit format, and add the GitHub issue templates (bug_report.yml, feature_request.yml, contract_issue.yml) and a PR template that prompts for test evidence. I'll validate that a new contributor can set up the project from CONTRIBUTING.md alone before opening a PR. Happy to contribute to the Stellar ecosystem!

  5. ranjeet150 commented on Oct 2, 2026

    @ranjeet150

    Greetings @maintainers,

    I would like to take on and implement this issue: [DX] Expand CONTRIBUTING.md — full setup guide, PR checklist, issue templates.

    Technical Implementation Roadmap:

    1. Formal Soroban Invariant Design: Audit storage layout (Instance, Persistent, Temporary) with strict TTL management and explicit require_auth guards.
    2. Core Rust WASM Implementation: Implement deterministic state transition handlers eliminating arithmetic overflow risks using checked/saturating math.
    3. Hermetic Testing Suite: Build comprehensive test cases in tests/ asserting authorized vs unauthorized invocations, mock auth environments, and edge value bounds.
    4. Gas & Footprint Optimization: Profile CPU/memory instruction budgets under Soroban host environment to ensure optimal runtime efficiency.

    I am ready to begin implementation immediately upon assignment and will deliver a high-quality, fully-tested PR. Please assign this issue to me!

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official CampaigndocumentationDocs, guides, or commentsdxDeveloper experience improvementsgood first issueAccessible to verified senior contributors new to this codebase

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions