Contributing to Collaboratex

How to get started?

well, what do we have here??

Fork & Clone

1. Fork the repository on GitHub
   github.com/yourusername/collaboratex

2. Clone your fork
   git clone https://github.com/yourusername/collaboratex.git
   cd collaboratex

3. Add upstream remote
   git remote add upstream https://github.com/original/collaboratex.git

Create Feature Branch

git checkout -b feature/your-feature-name

Branch naming:
├─ feature/add-dark-mode
├─ fix/websocket-reconnection
├─ docs/update-readme
├─ refactor/optimize-sync
└─ test/add-unit-tests

Development Setup

For Development setup see this

Commit Guidelines

Commit Messages

Good commit messages:
- fix: resolve websocket reconnection timeout issue
- feat: add dark mode toggle to editor
- docs: update authentication flow diagram
- refactor: optimize yjs update batching
- test: add unit tests for addCollaborator resolver

Format: type(scope): brief description
- Keep under 50 characters
- Use imperative mood ("add" not "added")
- No period at end

Pull Request Process

Before Submitting

Make sure you’re on latest upstream

1. Sync with upstream
   git fetch upstream
   git rebase upstream/main

2. Push to your fork
   git push origin feature/your-feature

3. Go to GitHub and create PR

Have a nice day!!