From 0ae5be3e428628c0ac9c97e03648192b5d9b0c3c Mon Sep 17 00:00:00 2001
From: "Tobin C. Harding" <me@tobin.cc>
Date: Fri, 31 May 2024 10:19:41 +1000
Subject: [PATCH] docs: Add more info to the update api files section

Done to try to further help new contributors and save maintainer time.

Add an example of using `just check-api` and an example `git` command
for devs to create the api patch now required for all changes to the
public API.
---
 CONTRIBUTING.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c12380e37..64931d205 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -200,6 +200,13 @@ All PRs that change the public API of `rust-bitcoin` must include a patch to
 the `api/` text files. This should be a separate, final patch to the PR
 that is the diff created by running `./contrib/check-for-api-changes.sh`.
 
+Or use `just`:
+
+```bash
+just check-api
+git commit -a -m 'api: Run just check-api'
+```
+
 ### Policy
 
 We have various `rust-bitcoin` specific coding styles and conventions that are