Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (61 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

78 lines (61 loc) · 2.57 KB

🚀 Contributing to Web3Bridge Alumni Portal

Thank you for your interest in contributing to the Web3Bridge Alumni Portal! This portal connects alumni, recruiters, and ecosystem partners, showcasing the strength of the Web3Bridge network.

🛠 Tech Stack

  • Frontend: React.js / Next.js
  • Backend: Node.js (NestJS or Express)
  • Database: PostgreSQL / MongoDB
  • Authentication: Auth0 / Firebase / Web3 Login
  • Styling: CSS Modules / TailwindCSS (if applicable)

🏗 Development Setup

Prerequisites

  • Node.js (LTS version recommended)
  • Git

Installation

  1. Fork the repository and clone it to your local machine.

    git clone https://github.com/YOUR_USERNAME/Web3bridge-Alumni-Portal.git
cd Web3bridge-Alumni-Portal

  2. Install Dependencies

    npm install

  3. Environment Setup

    • Copy the example environment file: 
      cp .env.example .env.local
    • Fill in the required environment variables in .env.local.

  4. Start the Development Server

    npm run dev

    Open http://localhost:3000 with your browser to see the result.

🌵 Branching Workflow

We follow a structured branching model:

  • main: Production-ready code. Do not push directly here.
  • develop: The integration branch. All feature PRs should target this branch.
  • Feature Branches: Create a new branch for each task using the format:
    • feat/feature-name (e.g., feat/search-filter)
    • fix/bug-name (e.g., fix/mobile-nav)

📝 Contribution Guidelines

1. Pick an Issue

Check the GitHub Project Board/Issues for open tasks. Assign yourself to an issue before starting work to avoid duplication.

2. Commit Messages

We use Conventional Commits to keep our history clean and readable.

  • feat: add user profile page
  • fix: resolve login timeout issue
  • docs: update readme
  • style: fix navbar alignment
  • refactor: optimize database query

3. Pull Requests

  • Target standard: All PRs must target the develop branch.
  • Description: clearly describe what your changes do. Link the related issue (e.g., "Closes #12").
  • Review: Wait for at least one code review approval before merging.

4. Code Quality

  • Ensure the code allows for scalability and performance.
  • Run npm run lint to check for style issues before committing.
  • Ensure your code is accessible (WCAG-compliant).

🤝 Code of Conduct

We are committed to providing a welcoming community. Please treat everyone with respect and empathy.