Development

Contributing to Migration Script Runner - setup, workflow, and standards.

Overview

This section contains documentation for developers who want to contribute to Migration Script Runner. Whether you’re fixing a bug, adding a feature, or improving documentation, you’ll find everything you need here.

Getting Started

🚀 Development Setup

Set up your development environment:

  • Clone and install dependencies
  • Run tests and build
  • IDE configuration
  • Development tools

🔧 Development Workflow

Learn the development process:

  • Branching strategy
  • Making changes
  • Testing requirements
  • Code review process

🤝 Contributing Guide

Contribution guidelines and standards:

  • Code of conduct
  • How to contribute
  • Pull request process
  • Issue reporting

Architecture & Design

🏗️ Architecture Overview

System design and components:

  • High-level architecture
  • Service layer design
  • Data flow and lifecycle
  • Design patterns used

Testing

🧪 Testing Guide

Comprehensive testing documentation:

  • Unit testing
  • Integration testing
  • Mutation testing
  • Test coverage requirements

Release Process

📦 Publishing New Versions

Release and publishing workflow:

  • Version management
  • Release checklist
  • Publishing to npm
  • Documentation updates

Development Standards

  • Code Quality: 100% test coverage, zero any types
  • Architecture: SOLID principles, clean separation of concerns
  • Documentation: JSDoc for all public APIs, comprehensive guides
  • Testing: Unit + Integration + Mutation testing
  • Git: Conventional commits, feature branches

Need Help?

If you have questions about development:

  1. Check the relevant development guide
  2. Search GitHub Issues
  3. Ask in a new issue with the question label
  4. Review existing Pull Requests for examples

Table of contents