howto/Getting-Started.md
... ...
@@ -30,19 +30,45 @@ Remember to add authentication to your `mntner` object, and you **must** [sign y
30 30
31 31
*Tip: Remember to keep a backup of your authorisation keys*
32 32
33
-The registry includes a number of scripts to help check your request:
33
+The registry includes scripts to help you with squashing and signing:
34 34
35
- - `fmt-my-stuff <FOO>-MNT`: automatically fixes minor formatting errors
36
- - `check-my-stuff <FOO>-MNT`: validates your objects against the registry schema
37
- - `check-pol origin/master <FOO>-MNT`: checks for policy violations
38 35
- `squash-my-commits`: automatically update and squash your local commits
39 36
- `sign-my-commit`: sign your commit using a pgp key or standard SSH signing
40 37
41
-The registry maintainers run the checking scripts against each request, so please run these yourself first to check for simple errors.
42
-
43 38
Do browse through the registry and look at the [pull request queue](https://git.dn42.dev/dn42/registry/pulls) to see examples, understand how the process works and see the types of questions asked by the registry maintainers.
44 39
45
-*You cannot use the gitea web interface to edit files, doing so creates a large number of commits and prevents running of the registry scripts*
40
+*You cannot use the gitea web interface to edit files, doing so creates a large number of commits and prevents you from checking your submission*
41
+
42
+### Validating your changes before submitting
43
+
44
+Before pushing your branch or opening a pull request, always format
45
+and validate your objects locally to catch schema errors or missing
46
+references early.
47
+
48
+
49
+The `registry` repository provides helper scripts for immediate validation:
50
+
51
+```sh
52
+./fmt-my-stuff <YOUR-MNT> # Auto-format indentation
53
+./check-my-stuff <YOUR-MNT> # Validate schema and references
54
+./check-pol origin/master <YOUR-MNT> # Check DN42 policy compliance
55
+```
56
+
57
+To run the exact CI/CD test suite executed by the pipeline automation bot on
58
+https://git.dn42.dev, you can run the [pipeline-docker](https://git.dn42.dev/dn42/pipeline-docker)
59
+container locally using Podman or Docker. Simply clone the repository
60
+and run the check.sh wrapper against your local registry:
61
+
62
+```sh
63
+git clone https://git.dn42.dev/dn42/pipeline-docker.git
64
+./pipeline-docker/check.sh /path/to/registry
65
+```
66
+
67
+The tool runs in safe local mode (read-only), verifying your commit
68
+signatures, route objects, and policy rules so you can fix any issues
69
+before submitting your pull request.
70
+
71
+All these scripts get run automatically on your PR, so please run these yourself first to check for simple errors.
46 72
47 73
---
48 74