Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
133 lines (90 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

133 lines (90 loc) · 2.38 KB
Raw

Contributing Guide

This guide is intentionally simple so anyone can start quickly.

1) Before You Start

  • Check open issues in GitHub Issues.
  • Pick one and try to solve it in the given time

2) Branch Rule (One Branch Per Issue)

Create a separate branch for each issue.

Branch name format:

  • issue-<issue-number>-<short-title>

Examples:

  • issue-5-profile-nav-state
  • issue-9-secure-ipfs-upload

Do not solve multiple issues in one branch.

3) Local Setup

Clone and install dependencies:

git clone https://github.com/Sumanthvu/Event_Dapp.git
cd Event_Dapp

Frontend setup:

cd event-dappp
npm install
npm start

Subgraph setup:

cd ../event-ticketinng
npm install
npm run codegen
npm run build

4) Create Your Branch

From repository root:

git checkout main
git pull origin main
git checkout -b issue-<issue-number>-<short-title>

5) Development Rules

  • Keep changes focused only on selected issue.
  • Follow acceptance criteria from the issue.
  • Do not commit secrets, private keys, JWTs, or API tokens.
  • Prefer small, readable commits.
  • If issue requires docs update, include it in same PR.

6) Commit Message Style

Use clear commit messages:

  • feat: add state-based profile navigation
  • fix: remove stale learn react test
  • docs: update frontend README setup
  • test: add mapping coverage for TicketPurchased

7) Verify Before Push

Frontend checks:

cd event-dappp
npm test -- --watchAll=false
npm run build

Subgraph checks (if changed):

cd ../event-ticketinng
npm run codegen
npm run build
npm test

8) Push and Open PR

git add .
git commit -m "<your message>"
git push origin issue-<issue-number>-<short-title>

Then open a Pull Request and use the PR template.

In PR description, add:

  • Closes #<issue-number>

This auto-closes the linked issue after merge.

9) PR Checklist

  • One issue, one branch, one PR.
  • Linked issue number is included.
  • Acceptance criteria are completed.
  • Tests pass locally.
  • No unrelated file changes.

10) Review and Changes

  • Maintainers may request changes.
  • Push updates to the same branch.
  • Do not open a new PR for review fixes.

11) Good First Contribution Flow

  • Start from difficulty:easy and good first issue labels.
  • Ask questions in issue comments if blocked.
  • Keep PR small for faster review.

Thank you for contributing.