Skip to content

Commit

Permalink
CAP: Add examples of how to generate and apply diffs of xdr files (#935)
Browse files Browse the repository at this point in the history
  • Loading branch information
leighmcculloch authored May 4, 2021
1 parent d07f14d commit 9b0d752
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion cap-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,13 @@ The technical specification should describe the syntax and semantics of any new
### XDR changes
This section includes all changes to the XDR (`.x` files), presented as a "diff"
against the latest version of the protocol (or in some rare exception,
on top of a different CAP).
on top of a different CAP). Diffs should be generated against on the XDR in the
[stellar-core repository].

To generate diffs, use the `git diff` command.

To apply diffs, use the `git apply --reject --whitespace=fix` command.

For large changes, it may be beneficial to link to actual XDR files copied
in the relevant "contents" folder.

Expand Down Expand Up @@ -126,3 +132,5 @@ The implementation(s) must be completed before any CAP is given "Final" status,
completed before the CAP is accepted. While there is merit to the approach of reaching consensus on
the specification and rationale before writing code, the principle of "rough consensus and running
code" is still useful when it comes to resolving many discussions of API details.

[stellar-core repository]: https://github.com/stellar/stellar-core

0 comments on commit 9b0d752

Please sign in to comment.