Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (36 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 1.54 KB

Contributing Guide

Setup

After cloning the repository, install the commit linting tools:

npm install

This will install Husky git hooks that automatically enforce Conventional Commits on every commit

Workflow

  1. Pick a task from Kanban Board
  2. Create a new branch from development (name it feature/<FEATURE-NAME> or bug/<BUG-NAME>)
  3. Commit your changes using Conventional Commits format:
    • Format: <type>(<scope>): <subject> #<issue>
    • Example: feat(api): add transaction import #23
    • Allowed types: feat, fix, docs, chore, refactor, test, perf, build, ci, revert, style
  4. Push your branch and open a Pull Request against development
  5. Wait for workflows and code review and make any requested changes
  6. Sync with development

Commit Message Format

All commits must follow the Conventional Commits specification. The commit message hook will prevent invalid commits locally, and CI will verify all commits in pull requests

Logging

We use Serilog for structured logging. Inject ILogger<T> in your class:

public class Service
{
    private readonly ILogger<Service> loger;

    public Service(ILogger<Service> logger)
    {
        this.loger = logger;
    }

    public void DoWork(int userId)
    {
        loger.LogInformation("Processing user {UserId}", userId);
    }
}

Available log levels: LogDebug, LogInformation, LogWarning, LogError, LogCritical