Skip to content

CONTRIBUTING-EN.md

Latest commit

 

History

History
97 lines (75 loc) · 2.85 KB

CONTRIBUTING-EN.md

File metadata and controls

97 lines (75 loc) · 2.85 KB
Raw

Contributing Guide

Thanks for your interest in Hercules! This document describes how to set up your environment, format your changes, and submit them to the project.

📋 Contents

Code of Conduct

By participating in the project, you agree to abide by the Code of Conduct.

Environment Setup

Requirements

First Run

git clone https://github.com/<owner>/hercules.git
cd hercules

# Backend
dotnet restore
dotnet build Hercules.slnx

# Frontend
cd hercules-web && npm install && cd ..

See more: docs/QUICKSTART.md.

Branch Structure

  • main — stable branch, always builds.
  • feature/<short-name> — new functionality.
  • fix/<short-name> — bug fix.
  • docs/<short-name> — documentation changes.

Create branches from the current main.

Commit Conventions

We use Conventional Commits:

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

[body — optional]

Types: feat, fix, docs, refactor, test, chore, perf, build, ci.

Examples:

feat(llm): add streaming response support for Ollama
fix(memory): properly escape Cyrillic in user_profile.md
docs(api): describe the /api/skills/{id}/improve endpoint

Code Style

C#

  • Follow the rules in .editorconfig.
  • nullable is enabled — avoid suppressing warnings without reason.
  • Comments and user-facing messages are in Russian.
  • Type/method names are PascalCase; local variables/parameters are camelCase.
  • Before opening a PR, run: 
    dotnet build Hercules.slnx -warnaserror
dotnet format Hercules.slnx --verify-no-changes

TypeScript / Astro

  • Type API calls through src/lib/api.ts.
  • Use TailwindCSS utility classes; avoid inline styles.

Pull Request Process

  1. Create a branch from main.
  2. Make your changes and ensure the project builds without errors and warnings.
  3. Update the documentation (README.md / docs/) when behavior changes.
  4. Open the PR using the template; describe the motivation and how to verify.
  5. Wait for CI to pass and review to complete.

Reporting Bugs

Open an Issue using the appropriate template. Provide:

  • .NET version (dotnet --version) and OS;
  • active LLM provider;
  • reproduction steps and expected/actual behavior;
  • logs or screenshots if available.

Security vulnerabilities — see SECURITY.md (do not open public Issues).