Contributing Guidelines¶

Thank you for considering contributing to Prediction DAO Research! This document provides guidelines for contributing.

Code of Conduct¶

Be respectful, inclusive, and collaborative. We're building something important together.

How to Contribute¶

Reporting Bugs¶

Check if the bug is already reported in GitHub Issues
If not, create a new issue with:
Clear title and description
Steps to reproduce
Expected vs actual behavior
Environment details (OS, Node version, etc.)
Screenshots if applicable

Suggesting Features¶

Check existing issues and discussions
Create a new issue with label "enhancement"
Describe the feature and its benefits
Explain use cases
Consider implementation approach

Pull Requests¶

Fork the repository
Create a branch from main:
```
git checkout -b feature/my-feature
```
Make your changes with clear commits
Write tests for new functionality
Update documentation as needed
Run tests to ensure everything passes
Submit a pull request with clear description

Development Workflow¶

Setup¶

git clone https://github.com/YOUR_USERNAME/prediction-dao-research.git
cd prediction-dao-research
npm install
cd frontend && npm install && cd ..

Making Changes¶

# Create feature branch
git checkout -b feature/my-feature

# Make changes
# ... edit files ...

# Run tests
npm test

# Run linting
cd frontend && npm run lint && cd ..

# Commit changes
git add .
git commit -m "Add feature: description"

# Push to your fork
git push origin feature/my-feature

Pull Request Process¶

Update README.md or documentation if needed
Ensure all tests pass
Update CHANGELOG.md (if exists)
Smart Contract PRs: The Ethereum Security Review Agent will automatically review all .sol file changes for security vulnerabilities and best practices compliance
Create pull request with:
Clear title
Description of changes
Related issue numbers
Screenshots (for UI changes)

Coding Standards¶

Solidity Style¶

Follow the Solidity Style Guide:

// SPDX-License-Identifier: Apache-2.0
pragma solidity ^0.8.20;

/**
 * @title MyContract
 * @notice Brief description
 * @dev Detailed implementation notes
 */
contract MyContract {
    // Constants
    uint256 public constant MAX_VALUE = 1000;

    // State variables
    address public owner;
    mapping(uint256 => Proposal) public proposals;

    // Events
    event ProposalCreated(uint256 indexed proposalId);

    // Modifiers
    modifier onlyOwner() {
        require(msg.sender == owner, "Not owner");
        _;
    }

    // Functions (grouped by visibility)
    constructor() {
        owner = msg.sender;
    }

    function publicFunction() external {
        // Implementation
    }

    function _internalFunction() internal {
        // Implementation
    }
}

JavaScript/React Style¶

// Use ES6+ features
const MyComponent = ({ prop1, prop2 }) => {
  const [state, setState] = useState(initialValue);

  useEffect(() => {
    // Side effects
  }, [dependencies]);

  const handleClick = () => {
    // Event handler
  };

  return (
    <div className="my-component">
      {/* JSX */}
    </div>
  );
};

export default MyComponent;

Naming Conventions¶

Contracts: PascalCase (e.g., ProposalRegistry)
Functions: camelCase (e.g., submitProposal)
Constants: UPPER_SNAKE_CASE (e.g., MAX_PROPOSAL_AMOUNT)
Private functions: _leadingUnderscore (e.g., _internalHelper)
Events: PascalCase (e.g., ProposalSubmitted)

Comments and Documentation¶

/**
 * @notice Submit a new proposal to the DAO
 * @param title The proposal title (max 100 characters)
 * @param description Detailed proposal description
 * @param fundingAmount Amount of ETC requested
 * @param recipient Address to receive funds if approved
 * @param welfareMetricId Which metric to evaluate against
 * @return proposalId The ID of the created proposal
 */
function submitProposal(
    string memory title,
    string memory description,
    uint256 fundingAmount,
    address recipient,
    uint256 welfareMetricId
) external payable returns (uint256) {
    // Implementation
}

Testing Requirements¶

Required Tests¶

All new features must include:

Unit tests for individual functions
Integration tests for contract interactions
Edge case tests for boundary conditions
Failure tests for error handling

Running Tests¶

# Run all tests
npm test

# Run specific test
npx hardhat test test/ProposalRegistry.test.js

# Check coverage
npm run test:coverage

Test Coverage¶

Aim for:

Statements: > 95%
Branches: > 90%
Functions: > 95%

Git Commit Messages¶

Write clear, descriptive commit messages:

Add proposal submission validation

- Validate title length (max 100 chars)
- Check funding amount against limits
- Ensure welfare metric exists
- Add corresponding tests

Fixes #123

Format:

<type>: <subject>

<body>

<footer>

Types:

feat: New feature
fix: Bug fix
docs: Documentation changes
test: Adding tests
refactor: Code refactoring
style: Code style changes
chore: Build/tooling changes

Documentation¶

Update documentation for:

New features
Changed behavior
New configuration options
API changes

Documentation locations:

docs/ - MkDocs documentation
README.md - Project overview
Code comments - Inline documentation
Test files - Usage examples

Review Process¶

For Contributors¶

Submit PR with clear description
Respond to review feedback
Make requested changes
Re-request review when ready

For Reviewers¶

Be constructive and respectful
Explain reasoning for changes
Approve when satisfied
Help contributors improve

Security¶

Automated Security Review¶

All smart contract code changes are automatically reviewed by the Ethereum Security Review Agent:

Automatic Analysis: Detects vulnerabilities in Solidity code
EthTrust Standards: Follows Ethereum Trust Alliance Security Levels
Best Practices: Enforces secure coding patterns
Quick Start: See Ethereum Security Quick Start
Full Guide: See Ethereum Security Agent Documentation

Reporting Vulnerabilities¶

DO NOT create public issues for security vulnerabilities.

Instead:

Email [email protected]
Include detailed description
Provide reproduction steps
Wait for acknowledgment

Security Review¶

All security-critical changes require:

Additional review by security team
Audit trail documentation
Comprehensive testing
Deployment checklist

Questions?¶

Check the FAQ
Join community discussions
Ask in GitHub Discussions
Reach out to maintainers

License¶

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.

Thank you for contributing! 🎉