Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
283 lines (201 loc) · 6.14 KB

CONTRIBUTING.md

File metadata and controls

283 lines (201 loc) · 6.14 KB
Raw

Contributing to Stellar

Thank you for your interest in contributing to Stellar! This guide will help you get started.

🚀 Quick Start

Prerequisites

  • Node.js 18+
  • Docker & Docker Compose
  • Git
  • Basic knowledge of TypeScript, React, and Node.js

Setup

  1. Fork the repository

    git clone https://github.com/YOUR_USERNAME/stellar.git
cd stellar

  2. Install dependencies

    npm run setup

  3. Start development environment

    npm run dev

  4. Run tests

    npm test

📁 Project Structure

stellar/
├── .github/                # GitHub workflows and templates
├── contracts/              # Smart contracts (Solidity)
├── backend/                # Node.js API server
├── frontend/               # React web application
├── shared/                 # Shared utilities and types
├── docs/                   # Documentation
├── scripts/                # Development and deployment scripts
└── tools/                  # Development tools and utilities

🏗️ Development Workflow

1. Find an Issue

  • Browse open issues
  • Look for issues labeled good first issue for beginners
  • Check issues labeled help wanted for community contributions

2. Claim an Issue

  • Comment on the issue with "I'd like to work on this"
  • Wait for maintainer assignment
  • Create a new branch from main

3. Development

# Create feature branch
git checkout -b feature/your-feature-name

# Make your changes
# Run tests frequently
npm test

# Run linting
npm run lint

# Run type checking
npm run type-check

4. Submit Pull Request

  • Push your branch to your fork
  • Create a pull request with:
    • Clear title and description
    • Link to related issue
    • Testing instructions
    • Screenshots if applicable

🔧 Development Guidelines

Code Style

  • Use TypeScript for all new code
  • Follow existing naming conventions
  • Add JSDoc comments for public APIs
  • Keep functions small and focused

Privacy First

  • Always consider privacy implications
  • Use existing encryption utilities
  • Add privacy audit logs for new features
  • Test with different privacy levels

Testing

  • Write unit tests for new functions
  • Add integration tests for API endpoints
  • Test privacy features thoroughly
  • Maintain test coverage above 80%

Documentation

  • Update README for new features
  • Add API documentation for new endpoints
  • Document privacy considerations
  • Update deployment guides if needed

📋 Issue Types

Bug Reports

Use the Bug Report template and include:

  • Clear description of the issue
  • Steps to reproduce
  • Expected vs actual behavior
  • Environment details
  • Privacy level configuration

Feature Requests

Use the Feature Request template and include:

  • Problem statement
  • Proposed solution
  • Privacy considerations
  • Implementation ideas
  • Alternative approaches

Smart Contract Issues

For blockchain-related issues:

  • Specify contract name
  • Include transaction hash if applicable
  • Describe blockchain network
  • Gas cost considerations

🎯 Areas for Contribution

Frontend (React/TypeScript)

  • Privacy dashboard improvements
  • Data visualization components
  • Mobile responsive design
  • Accessibility improvements
  • Performance optimization

Backend (Node.js/TypeScript)

  • API performance optimization
  • New privacy algorithms
  • Database query optimization
  • Caching strategies
  • Security enhancements

Smart Contracts (Solidity)

  • Privacy-preserving oracle integrations
  • Gas optimization
  • Access control mechanisms
  • Audit trail improvements
  • Cross-chain compatibility

Documentation

  • API documentation improvements
  • Tutorial creation
  • Video guides
  • Translation to other languages
  • Architecture diagrams

🔒 Privacy & Security

Security Review Process

  1. Code review by maintainers
  2. Automated security scanning
  3. Privacy impact assessment
  4. Smart contract audit (if applicable)

Reporting Security Issues

📦 Release Process

Version Management

  • Follow Semantic Versioning
  • Use conventional commits
  • Update CHANGELOG.md
  • Tag releases properly

Deployment

  1. Update version numbers
  2. Run full test suite
  3. Update documentation
  4. Create release tag
  5. Deploy to staging
  6. Deploy to production

🏆 Recognition

Contributor Recognition

  • Contributors listed in README
  • Annual contributor awards
  • Swag for significant contributions
  • Speaking opportunities at conferences

Maintainer Program

  • Active contributors can apply
  • Review pull requests
  • Guide new contributors
  • Shape project direction

💬 Community

Communication Channels

Events

  • Weekly office hours
  • Monthly contributor meetings
  • Quarterly hackathons
  • Annual conference

📚 Resources

Development Tools

Learning Resources

🤝 Getting Help

Quick Help

Maintainer Support

  • Tag maintainers in issues
  • Use @stellar/maintainers team
  • Schedule office hours call

📄 License

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

🌟 Thank You

Your contributions make Stellar better for everyone. We appreciate your time and effort in building privacy-first technology!