From 30eaac653564e51a92e94f9ef0b1c37bc4d48695 Mon Sep 17 00:00:00 2001 From: Magne Sjaastad Date: Tue, 10 Mar 2026 11:26:46 +0100 Subject: [PATCH] Docs: Update Git and PR conventions - Restructure Git conventions into sub-sections for better organization - Add a new convention to exclude test plans from PR descriptions --- docs/agents/core.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/agents/core.md b/docs/agents/core.md index db697661a9..d7499ad04c 100644 --- a/docs/agents/core.md +++ b/docs/agents/core.md @@ -69,12 +69,16 @@ ResInsight includes Python integration via gRPC when `RESINSIGHT_ENABLE_GRPC=ON` - Third-party dependencies: `ThirdParty/` with individual CMakeLists.txt files - Python API: `GrpcInterface/Python/` -## Git Commit Conventions +## Git +### Commit Conventions - When creating a git commit for a feature request use the issue number at the start of the title, e.g "#12773 Python: Add API for creating valve templates" - When creating a commit use git conventions - Always run python formatting/check on changed files before commits +### PR Conventions +- Do not include a test plan in the PR description + ## Making PDM Objects Scriptable for Python GRPC Interface To make a PDM (Project Data Model) object available in the Python GRPC interface, you need to make it "scriptable":