Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
119 lines (81 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

119 lines (81 loc) · 3.19 KB
Raw

Contributing to Transparently

Thank you for your interest in contributing to Transparently — an on-chain governance DApp where every vote, every decision, and every dollar is recorded immutably on the blockchain. Transparently is a project of The Elevation Foundation, a 501(c)(3) nonprofit organization.

Table of Contents

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you agree to uphold this standard. Report unacceptable behavior to dev@elevation.foundation.

How to Contribute

Reporting Bugs

Search existing issues before filing. Include:

  • Clear, descriptive title
  • Steps to reproduce
  • Expected vs. actual behavior
  • Environment details (Node.js version, network, browser)
  • Relevant logs or screenshots

Contributing Code

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature-name
  3. Make your changes following the guidelines below
  4. Write or update tests
  5. Submit a pull request

Development Setup

Prerequisites

  • Node.js v18+
  • pnpm or npm
  • Hardhat (for smart contracts)
  • MetaMask or compatible wallet (for frontend testing)

Installation

git clone https://github.com/ModernDigitalDevelopment/transparently.git
cd transparently
npm install
cp .env.example .env
# Fill in your environment variables

Running Tests

# Smart contract tests
cd packages/contracts
npx hardhat test

# Frontend tests
cd frontend
npm test

Smart Contract Guidelines

Transparently contracts govern real governance decisions. Security is paramount.

Security Standards

  • Use OpenZeppelin libraries for standard patterns
  • Follow checks-effects-interactions pattern
  • Use ReentrancyGuard on all value-transferring functions
  • Emit events for all state changes
  • Write NatSpec documentation for all public functions

Core Contracts

Transparently uses four core governance contracts:

  • TransparentlyGovernor.sol — main governance contract
  • TransparentlyToken.sol — governance token
  • TransparentlyTreasury.sol — on-chain treasury
  • TransparentlyOracle.sol — off-chain data verification

Commit Message Format

Use Conventional Commits:

feat: add quadratic voting to TransparentlyGovernor
fix: prevent double-vote in proposal lifecycle
docs: update deployment guide for Base Sepolia
test: add coverage for treasury withdrawal flow

Community & Support

The Elevation Foundation is a 501(c)(3) nonprofit. EIN: 93-2511290.