Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
190 lines (137 loc) · 5.49 KB

CONTRIBUTING.md

File metadata and controls

190 lines (137 loc) · 5.49 KB
Raw

Contributing to Linkora-socials

Thank you for contributing! This document covers everything you need to go from zero to an open pull request.

⭐ Star the repo — Epta-Node/Linkora-social 💬 Join Telegram — t.me/+13csp8G4ccRhY2Zk

Please introduce yourself in Telegram before opening a PR to avoid duplicate work.

Prerequisites

Install the following before working on the project:

Tool Version Install
Node.js 18+ nodejs.org
pnpm 9+ npm install -g pnpm
Rust toolchain latest stable curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Stellar CLI latest cargo install --locked stellar-cli

Add the Wasm target required for contract builds:

rustup target add wasm32-unknown-unknown

Repository Structure

.
├── packages/
│   └── contracts/          # Soroban smart contracts (Rust / Cargo workspace)
│       └── contracts/
│           └── linkora-contracts/
│               └── src/
│                   ├── lib.rs    # Contract implementation
│                   └── test.rs   # Unit tests
├── docs/                   # Architecture, design, and indexer specs
├── scripts/                # Setup, deploy, and release scripts
├── tests/                  # Sandbox-backed integration tests
├── .github/                # CI workflows, issue/PR templates, CODEOWNERS
├── Makefile
├── turbo.json
└── pnpm-workspace.yaml

Local Setup

# 1. Clone your fork
git clone git@github.com:YOUR-USERNAME/Linkora-social.git
cd Linkora-social

# 2. Install JS dependencies
pnpm install

# 3. Build contracts
pnpm build:contracts

# 4. Run unit tests
pnpm --filter contracts test

Running each workspace package

Package Directory Command
Contracts (build) packages/contracts pnpm build or pnpm build:contracts from root
Contracts (test) packages/contracts cargo test or pnpm --filter contracts test
Contracts (format) packages/contracts cargo fmt
Integration tests repo root pnpm test:integration
Full lint repo root pnpm lint
Format all repo root pnpm format

Branch Naming

Prefix Use for
feat/ New features
fix/ Bug fixes
docs/ Documentation changes
test/ Adding or updating tests
chore/ Tooling, config, dependency updates

Example: feat/add-repost-function, fix/tip-cooldown-overflow, docs/update-readme

Always branch from main:

git checkout main && git pull
git checkout -b feat/your-feature-name

Commit Message Format

This project uses Conventional Commits:

<type>(<scope>): <short description>

[optional body]

[optional footer: Closes #issue]

Types: feat, fix, docs, test, chore, refactor, ci

Examples:

feat(contracts): add repost function with author attribution
fix(contracts): prevent tip cooldown bypass on deleted posts
docs: update CONTRIBUTING.md with full workflow
test(contracts): add unit tests for block_user edge cases

Rules:

  • Use the imperative mood ("add", not "added")
  • Keep the subject line under 72 characters
  • Reference the issue in the footer: Closes #123

Pull Request Checklist

Before opening a PR:

  • All tests pass locally (cargo test / pnpm --filter contracts test)
  • New behaviour is covered by tests
  • If a contract function was added or changed, the README API table is updated
  • Commit messages follow Conventional Commits format
  • Branch is up to date with main
  • PR is focused — one concern per PR
  • PR description fills out the template and references the issue (Closes #N)

Code Review Expectations

As an author:

  • Keep PRs small and focused — easier to review, faster to merge
  • Respond to review comments within a reasonable time
  • Don't force-push after a review has started; add new commits instead
  • Mark conversations as resolved only after addressing them

As a reviewer:

  • Review within 2–3 business days where possible
  • Be specific and constructive — suggest the fix, not just the problem
  • Approve only when you are confident the change is correct and tested
  • Use "Request changes" for blocking issues, "Comment" for non-blocking suggestions

Merge policy:

  • At least one approving review is required
  • CI must pass before merge
  • Squash or merge commits — no force-pushes to main

Adding a New Contract Function

  1. Implement the function in packages/contracts/contracts/linkora-contracts/src/lib.rs
  2. Add require_auth() for any state-changing operation
  3. Emit an event for indexer consumers (see EVENTS.md)
  4. Write unit tests in src/test.rs
  5. Update the API Reference table in README.md
  6. Add a changelog entry in CHANGELOG.md

Getting Help

  • 💬 Telegram — t.me/+13csp8G4ccRhY2Zk — fastest way to reach the team
  • 🐛 GitHub Issues — for bugs and feature requests
  • 🔒 Security issues — see SECURITY.md for private disclosure

Security

Do not open public issues for security vulnerabilities. Follow the process in SECURITY.md.