Skip to content
How-to guide

Proposing a Change

This guide shows how to suggest a change to Vultron: to the protocol, to this documentation, or to the reference implementation. All three are maintained in one public repository, CERTCC/Vultron, so every proposal starts in the same place.

Before you start

You need a GitHub account. Read the Open Questions first: if your question is already there, add to the issue it links rather than opening a new one.

Suggest the change

  1. Search the issues for one that already describes your change. If one does, comment on it.
  2. If your idea still needs discussion before it is a concrete proposal, start a thread in Discussions.
  3. Otherwise, open an issue. Say what you want to change, why, and which pages or behaviors it affects. For a protocol change, name the section of the Vultron Protocol Specification it touches.

What happens next

The maintainers reply on the issue. A change that alters how the protocol works is recorded as a decision record before it is made, so the reason for it stays on file. These records are reached from Working on This Implementation. A protocol change appears in a later draft of the specification; the specification's Revision Log explains how drafts are numbered and records what changed in each.

If you want to make the change yourself

Discuss it on the issue first, so your work matches what the maintainers will accept. Then follow Contributing, which sets out the terms of submission and how to open a pull request.