Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CAP: Add examples of how to generate and apply diffs of xdr files #935

Merged
merged 1 commit into from
May 4, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion cap-template.md
Original file line number Diff line number Diff line change
@@ -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.

@@ -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