Contributing

How to contribute to Morphir .NET - guidelines, setup, and design documentation

Thank you for your interest in contributing to Morphir .NET! This section provides everything you need to get started as a contributor.

Quick Start

  1. Fork the repository
  2. Clone your fork
  3. Set up your development environment
  4. Create a branch for your changes
  5. Submit a pull request

Development Setup

Prerequisites

  • .NET SDK 10.0 or higher
  • Git

Build & Test

# Build the project
dotnet build

# Run tests
dotnet test --nologo

# Format code (required before committing)
dotnet format

Install Git Hooks

dotnet tool restore
dotnet husky install

Coding Standards

  • Follow the existing code style
  • Use C# 14 / F# 9 features where appropriate
  • Prefer immutable data structures
  • Write comprehensive tests (TDD approach)
  • Update documentation as needed
  • Follow AGENTS.md for architectural guidance

Pull Request Process

  1. Ensure all tests pass: dotnet test --nologo
  2. Run code formatters: dotnet format
  3. Update documentation if needed
  4. Create a focused PR with a clear description
  5. Follow Conventional Commits format
  6. Ensure DCO is signed (see CONTRIBUTING.md)

Need Help?

Key Resources

ResourceDescription
AGENTS.mdComprehensive guidance for AI agents and developers
CONTRIBUTING.mdDCO and legal requirements
Code of ConductCommunity guidelines

Design Documentation

Design documents, PRDs, and architectural specifications for Morphir .NET

QA & Testing

Test plans, quality assurance practices, and testing documentation