Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (46 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

60 lines (46 loc) · 1.71 KB

Contributing to SocialENS

First off, thanks for taking the time to contribute! 🎉

SocialENS is a decentralized social network built for ETH HACK MONEY 2026. We welcome contributions from the community to help make decentralized social media a reality.

🛠️ Tech Stack

  • Framework: Next.js 14, Scaffold-ETH 2
  • Language: TypeScript
  • Styling: Tailwind CSS, DaisyUI
  • Blockchain: Ethereum Sepolia, ENS (Ethereum Name Service)
  • State Management: Wagmi v2, Viem

🚀 Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/SocialENS.git
cd SocialENS
  3. Install dependencies: 
    yarn install
  4. Set up environment variables:
    • Copy .env.example to .env.local
    • Add your NEXT_PUBLIC_SEPOLIA_RPC_URL (Alchemy or Infura)
  5. Run the development server: 
    yarn start

🤝 How to contribute

Reporting Bugs

  • Open an issue on GitHub.
  • clearly describe the issue, including steps to reproduce.

Suggesting Enhancements

  • Open an issue describing your idea.
  • Explain why this enhancement would be useful.

Pull Requests

  1. Create a new branch: git checkout -b feature/amazing-feature
  2. Make your changes.
  3. Commit your changes: git commit -m 'feat: Add amazing feature'
  4. Push to the branch: git push origin feature/amazing-feature
  5. Open a Pull Request.

📝 Code Style

  • We use Prettier for code formatting.
  • Ensure your code follows the existing style and conventions.
  • Use descriptive variable and function names.

📜 License

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