Contributing to SpeakWise

We’re excited to have you here! SpeakWise is an open-source project building a platform for event attendees, speakers, and organizers. This document explains how to set up your environment, our workflow, and how to contribute effectively.

---

1. Repositories

SpeakWise is split into two main repos:

• Frontend (Next.js + Tailwind, pnpm) 👉 speakwise-frontend

• Backend (Django + PostgreSQL) 👉 speakwise-backend

Each repo contains its own README.md for quick setup instructions, but this document serves as the overall contributor guide.

---

2. Getting Started

Frontend (Next.js + Tailwind)

1. Clone repo:

   git clone https://github.com/hellospeakwise-hq/speakwise-frontend.git
   cd speakwise-frontend

2. Install dependencies with pnpm:

   pnpm install

3. Run dev server:

   pnpm dev

Backend (Django + PostgreSQL)

1. Clone repo:

   git clone https://github.com/hellospeakwise-hq/speakwise-backend.git
   cd speakwise-backend

2. Create a virtual environment:

   python -m venv venv
   source venv/bin/activate   # macOS/Linux  
   venv\Scripts\activate      # Windows

3. Install dependencies:

   pip install -r requirements.txt

4. Setup PostgreSQL:

   • Create a DB called speakwise.
   • Update settings.py with your DB credentials.

5. Run migrations and start server:

   python manage.py migrate
   python manage.py runserver

---

3. Workflow

• Main Branch: Always stable.

• Develop Branch: Active development.

• Feature Branches:

  feature/event-filtering
  bugfix/email-verification
  

Process:

1. Pick/open an issue.
2. Assign yourself.
3. Branch off develop.
4. Commit changes (see commit guidelines).
5. Open a PR to develop.
6. Two reviews required before merge.

---

4. Commit Guidelines

Use Conventional Commits:

• feat: new feature
• fix: bug fix
• docs: documentation updates
• chore: configs, cleanup

Example:

feat: add anonymous feedback form for attendees

---

5. Code Style

• Frontend: Follow ESLint + Prettier configs.
• Backend: Follow PEP8.
• Tests: Write unit tests for all new features.

---

6. Issues & Pull Requests

• Link PRs to issues (Closes #42).
• Include test instructions + screenshots for UI changes.
• PRs require at least 2 approvals before merging.

---

7. Community

• Trello: task/roadmap tracking.
• GitHub Issues: feature requests & bugs.
• Discussions/Slack/Discord: general Q&A.

---

8. License

SpeakWise is open-source under the MIT License. By contributing, you agree your work will be released under this license.

---

👉 For speakwise-frontend and speakwise-backend, just add a short note in their README pointing here for full guidelines.