mirror of
https://gitlab.eurecom.fr/oai/openairinterface5g.git
synced 2026-07-13 04:30:28 +00:00
fef2154525
doc: add a Git guide (commit signing, branch management, rerere) (#202) Adds doc/git-guide.md, a single entry point for the practical Git knowledge needed to contribute to OAI: commit signing setup (DCO + verified commits), branch management (including fixup commits and --autosquash), submodules, recovering from mistakes, and reusing conflict resolutions with git rerere. This started as a rerere-only guide. Review discussion (@luispereira106, @rorsc, @sgarg00) converged on a broader scope: the Git how-tos are scattered across the documentation (signing in CONTRIBUTING.md, branch management in code-style-contrib.md), and configuring commit signing in particular was reported as hard to get right. This PR consolidates the how-tos in one guide while the policy documents stay authoritative for the rules. Single commit (review rounds squashed per the linear-history policy): - New doc/git-guide.md with sections on commit signing (moved from CONTRIBUTING.md, led by a copy-pasteable SSH recipe), branch management (moved from code-style-contrib.md; git switch, fixup/--autosquash, --fixup=amend:), submodules (unintended pointer-update pitfall), recovering from mistakes (restore/reset/reflog), and git rerere. - CONTRIBUTING.md keeps the normative DCO/Verified requirements and links to the guide; code-style-contrib.md keeps the workflow policy and links to the guide; doc/README.md lists the guide under Developer tools. - Cross-references (not moved, since they are coupled to their own docs): clang-format.md pre-commit hook, GET_SOURCES.md branch/tag model, doc_best_practices.md docs: commit prefix. - Small typo fix in the T tracer addconsoletrace.md documentation. Reviewed-by: Robert Schmidt <robert.schmidt@openairinterface.org> Reviewed-by: Francesco Mani <email@francescomani.it> Reviewed-by: Shubhika Garg <shubhika.garg@openairinterface.org>