conformallab/ConformalLabpp

Fork 0

Files

Tarik Moussa aa4df1b99d

C++ Tests / test-fast (push) Successful in 1m58s

Details

C++ Tests / test-cgal (push) Has been skipped

Details

release: v0.9.0 — finalise PR #11 with CHANGELOG, version bump, stub cleanup

Closes the v0.9.0 release loop on top of Phase 9a-Newton + Phase 8b-Lite:

* CHANGELOG.md (NEW) — Keep-A-Changelog format, with v0.9.0 entry
  detailing all Phase 9a / 9b / 8b-Lite contents and the doc-audit
  corrections that landed via PR #10.

* CITATION.cff — version 0.7.0 → 0.9.0, date 2026-05-18 → 2026-05-22.

* Stale HDS-port stubs removed (13 GTEST_SKIPs total):
  - code/tests/test_spherical_functional.cpp
  - code/tests/test_hyper_ideal_functional.cpp
  - code/tests/test_hyper_ideal_hyperelliptic_utility.cpp
  These referenced a "HDS port (Phase 4)" that never happened —
  CoHDS was intentionally replaced by CGAL::Surface_mesh, and the
  functional tests live in code/tests/cgal/test_*_functional.cpp.

* Test-count updates everywhere:
  - Non-CGAL  36 → 23  (drop = 13 deleted stubs)
  - CGAL      176 → 227
  - Total     212 → 250  (+38 net, 0 skipped)
  Files: README.md, CLAUDE.md, CHANGELOG.md, scripts/try_it.sh,
         doc/api/tests.md, doc/contributing.md, doc/getting-started.md,
         doc/math/validation.md.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

2026-05-22 04:25:59 +02:00

2.4 KiB

Raw Blame History

Contributing

Language

All code, comments, documentation, commit messages, and test descriptions must be in English.

The project targets CGAL submission and international collaboration. When editing files that still contain German-language comments or documentation, replace them with English.

Git workflow

main is protected on origin (Gitea). Push to dev, then open a pull request.
codeberg/main can be pushed to directly (public mirror, no CI).

Both remotes must stay in sync after every significant change:

git push origin HEAD:dev   # triggers CI
git push codeberg main     # updates public mirror

Branch naming: feature/<topic>, fix/<topic>, phase<N>-<topic>

CI

Two jobs run on push to dev/main or on pull requests:

Job	What it tests	Trigger
`test-fast`	23 non-CGAL tests, no Boost	all branches
`test-cgal`	227 CGAL tests, 0 skipped	`main`, `dev`, PRs only

A PR is ready to merge when both jobs pass.

The runner is a self-hosted Raspberry Pi (ARM64). See .gitea/workflows/cpp-tests.yml and .gitea/docker/Dockerfile.ci-cpp.

Test standards

Every new algorithm needs:

Gradient check — finite-difference verification of G(x) = ∂E/∂x. Copy any GradientCheck_* test suite from tests/cgal/test_*_functional.cpp.
Convergence test — Newton converges on a small mesh using the "natural theta" trick (see CLAUDE.md and api/extending.md).
Registration — add the .cpp file to code/tests/cgal/CMakeLists.txt.

Expected CI result: 23 + 227 tests pass, 0 skipped.

Code style

C++17. Header-only (code/include/*.hpp). No compiled library.
#pragma once at the top of every header.
Everything in the conformallab namespace, internal helpers in conformallab::detail.
Property map names follow the prefix convention: "v:" (vertex), "e:" (edge), "f:" (face).
DOF index -1 always means "pinned/fixed".

Releases

Release tags follow vMAJOR.MINOR.PATCH:

# Merge dev → main, then tag
git checkout main && git merge --no-ff dev
git tag -a vX.Y.Z -m "vX.Y.Z — <one-line summary>"
git push origin main && git push origin vX.Y.Z
git push codeberg main && git push codeberg vX.Y.Z

TODO

Define code review checklist
Add .clang-format configuration
Document how to request CGAL package review

2.4 KiB Raw Blame History