Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
244 lines (174 loc) · 5.94 KB

CONTRIBUTING.md

File metadata and controls

244 lines (174 loc) · 5.94 KB

Contributing to TaskNebula

Thank you for your interest in contributing to TaskNebula! This document provides guidelines and instructions for contributing.

🚀 Getting Started

Prerequisites

  • Node.js 22+ (LTS)
  • pnpm 9+
  • PostgreSQL 16+
  • Git

Development Setup

  1. Fork and clone the repository

    git clone https://github.com/neuraparse/taskNebula.git
cd tasknebula

  2. Install dependencies

    pnpm install

  3. Setup environment variables

    cp apps/web/.env.example apps/web/.env.local
cp packages/db/.env.example packages/db/.env

  4. Start PostgreSQL (using Docker)

    docker-compose up -d postgres

  5. Run database migrations

    pnpm db:generate
pnpm db:migrate

  6. Start development server

    pnpm dev

📁 Project Structure

taskNebula/
├── apps/
│   └── web/              # Next.js application
├── packages/
│   ├── config/           # Shared configurations
│   ├── types/            # TypeScript types
│   └── db/               # Database schema (Drizzle)
├── turbo.json            # Turborepo configuration
└── pnpm-workspace.yaml   # pnpm workspace configuration

🔧 Development Workflow

Branch Naming

  • feature/ - New features
  • fix/ - Bug fixes
  • docs/ - Documentation updates
  • refactor/ - Code refactoring
  • test/ - Test additions or updates

Example: feature/add-timeline-view

Commit Messages

We follow Conventional Commits and enforce them via commitlint on every commit:

<type>(<scope>): <description>

[optional body]

[optional footer]

Allowed types:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Code style changes (formatting, etc.)
  • refactor: Code refactoring
  • perf: Performance improvement
  • test: Adding or updating tests
  • build: Build system / dependency changes
  • ci: CI configuration changes
  • chore: Maintenance tasks
  • revert: Reverting a previous commit
  • infra: Infrastructure (Docker, Nginx, healthchecks, deploy)
  • ai: AI agents, prompts, model integration
  • integrations: Third-party integrations (GitHub, Slack, Sentry, webhooks, ...)

Examples:

feat(kanban): add drag and drop support
fix(auth): resolve session timeout issue
docs(readme): update installation instructions
infra(docker): tighten container healthchecks
integrations(github): add HMAC-signed webhook delivery

Git Hooks (Husky + lint-staged + commitlint)

The repository ships with Husky hooks that run automatically after pnpm install (via the prepare script):

  • pre-commit runs lint-staged:
    • *.{ts,tsx} → eslint --fix + prettier --write
    • *.{js,cjs,mjs,jsx,json,md,yml,yaml} → prettier --write
  • commit-msg runs commitlint against commitlint.config.cjs to enforce the conventional-commit format above.

If a hook prevents your commit, fix the reported issue and re-stage; do not bypass with --no-verify unless you have a very good reason and call it out in the PR.

Code Style

  • We use Prettier for code formatting
  • We use ESLint for linting
  • Hooks auto-format staged files on commit; you can also run:
    • pnpm format to format the whole repo
    • pnpm lint to check for issues

Type Checking

  • All code must be properly typed with TypeScript
  • Run pnpm type-check to verify types
  • Avoid using any - use proper types or unknown

🧪 Testing

# Run all tests
pnpm test

# Run tests in watch mode
pnpm test:watch

# Run tests with coverage
pnpm test:coverage

📝 Pull Request Process

  1. Create a feature branch

    git checkout -b feature/your-feature-name

  2. Make your changes

    • Write clean, well-documented code
    • Add tests for new features
    • Update documentation as needed

  3. Commit your changes

    git add .
git commit -m "feat: add your feature"

  4. Push to your fork

    git push origin feature/your-feature-name

  5. Create a Pull Request

    • Provide a clear description of the changes
    • Reference any related issues
    • Ensure all CI checks pass

PR Checklist

  • Code follows project style guidelines
  • Tests added/updated and passing
  • Documentation updated
  • Type checking passes (pnpm type-check)
  • Linting passes (pnpm lint)
  • No console errors or warnings
  • Commit messages follow conventional commits

🐛 Reporting Bugs

When reporting bugs, please include:

  • Description: Clear description of the bug
  • Steps to Reproduce: Detailed steps to reproduce the issue
  • Expected Behavior: What you expected to happen
  • Actual Behavior: What actually happened
  • Environment: OS, Node version, browser, etc.
  • Screenshots: If applicable

💡 Feature Requests

We welcome feature requests! Please:

  • Check if the feature has already been requested
  • Provide a clear use case
  • Explain how it aligns with TaskNebula's vision
  • Consider contributing the feature yourself!

📚 Documentation

  • Update README.md for user-facing changes
  • Update inline code comments for complex logic
  • Add JSDoc comments for public APIs
  • Update type definitions as needed

🤝 Code of Conduct

  • Be respectful and inclusive
  • Provide constructive feedback
  • Focus on what is best for the community
  • Show empathy towards other community members

📞 Getting Help

  • Discord: Join our Discord (coming soon)
  • GitHub Discussions: Ask questions and share ideas
  • GitHub Issues: Report bugs and request features

📄 License

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

Thank you for contributing to TaskNebula! 🌌