milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

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.
This commit is contained in:
Tobin C. Harding 2024-05-31 10:19:41 +10:00
parent 3c87d0c5a3
commit 0ae5be3e42
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -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 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`. 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 ### Policy
We have various `rust-bitcoin` specific coding styles and conventions that are We have various `rust-bitcoin` specific coding styles and conventions that are