MAKS-IT/maksit-certs-ui
1
0
Fork 0
mirror of https://github.com/MAKS-IT-COM/maksit-certs-ui.git synced 2026-05-16 04:48:12 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity
main
maksit-certs-ui/CONTRIBUTING.md

3.7 KiB
Raw Permalink Blame History

Contributing to MaksIT.CertsUI

Thank you for your interest in improving this project. This document describes how to set up a development environment, what we expect from contributions, and where to get help.

License

By contributing, you agree that your contributions will be licensed under the same terms as the project. See LICENSE.md (Apache License 2.0).

What to contribute

Useful contributions include bug fixes, documentation improvements, Helm chart updates, and small, focused feature changes that fit the architecture described in README.md (single agent, HTTP-01, and related limitations).

Large or architectural changes are best discussed first (see Contact) so effort aligns with project goals.

Architecture and code layout

Where the rules live: layering, folder responsibilities, persistence vs host boundaries, DI lifetimes, and an AI/contributor checklist are documented in assets/docs/ARCHITECTURE_LAYERING.md. Read that before adding new Engine persistence, services, or cross-project dependencies.

Summary: MaksIT.CertsUI.Engine holds domain, PostgreSQL persistence (Linq2Db), migrations, and ACME engine code; it returns MaksIT.Results types, not HTTP responses. MaksIT.CertsUI is the web host (controllers, app services, ProblemDetails). Topic-specific design notes also live under assets/docs/ (HA, auth, proxy, etc.).

Development setup

Prerequisites

  • .NET SDK compatible with the TargetFramework values in the .csproj files under src/ (the main solution currently targets .NET 10).
  • Optional but recommended for end-to-end checks: Docker or Podman, as in the README installation sections.
  • Visual Studio 2022 (17.14+) or another editor with C# support works well; the solution file is src/MaksIT.CertsUI.slnx (SLNX; requires a recent dotnet SDK, e.g. 9.0.200+).

Build

From the repository root:

dotnet build src/MaksIT.CertsUI.slnx -c Release

Use Debug while iterating locally if you prefer.

Run the stack locally

Follow README.md for Podman Compose, Docker Compose, or Kubernetes (Helm). That is the supported way to exercise the WebAPI, WebUI, and reverse proxy together.

Automated tests: from the repo root, dotnet test src/MaksIT.CertsUI.Engine.Tests and dotnet test src/MaksIT.CertsUI.Tests (the latter may require a reachable PostgreSQL when integration tests run). For UI-only or deployment changes, manual verification through the WebUI and compose or cluster setup still applies.

Pull requests

  1. Branch from the branch the maintainers use for integration (often dev or main—check the default on the host repository).
  2. Keep changes scoped—one logical fix or feature per PR makes review and history easier.
  3. Describe the change in the PR: what problem it solves, how you tested it, and any operational impact (config, Helm values, images).
  4. Update CHANGELOG.md when the change is user-visible (behavior, security, deployment, or notable docs). Add entries under a new version heading or an [Unreleased] section at the top, following the existing Keep a Changelog style.
  5. Avoid unrelated formatting or drive-by refactors in the same PR as functional changes.

Security issues

Please do not open a public issue for undisclosed security vulnerabilities. Report them privately using the contact in README.md (Contact section) so they can be handled responsibly.

Contact

Questions and coordination: see Contact in README.md.