Sending Your Patch
This tutorial assumes that you already have basic git experience.
Before beginning, you’ll need to have a local git checkout of the Spectrum source tree. You’ll also need to have configured
git send-email — a guide for this can be found at https://git-send-email.io/.
The process of making changes is similar to working on any git repository.
Create a branch for your changes:
git checkout -b fix-docs # for example
Make changes in your editor.
Run the checks against your changes.
Stage and commit your changes:
git add Documentation/first-patch.adoc # for example git commit -sTip
-soption adds a
Signed-off-byline to the commit. This indicates your acceptance of the Developer’s Certificate of Origin, which is mandatory for Spectrum patches.
Once you’re happy with how the commits on your branch look, run:
git send-email --to email@example.com --confirm=always origin/main
For each message, you will be prompted for confirmation, and then the change will be submitted to the Spectrum development mailing list. They will appear shortly on the web interface.
| If you’re submitting multiple changes, and you’d like to provide an overall description for the whole series, you can add the |
Once your patch has been submitted, wait for it to be reviewed. Feedback, if any, will be sent as email replies to your submitted patch. You can respond to feedback in your mail client.
Use the Reply All button to sent your messages to the mailing list as well as to the person who sent the feedback.
If you need to make changes to your patch and submit a new version, use
git rebase to create a new version of your patch(es) and then submit it like this:
git send-email -v2 --to firstname.lastname@example.org --confirm=always origin/main
-v2 flag indicates that this is version two of your patch set. If your patches require more rounds of changes, submit subsequent rounds with
-v4, etc. as appropriate.
If you would like to describe what has changed from the previous version of your patches, you can do so in a cover letter as described above.
Once your patch has been accepted, it will be applied to the upstream Spectrum git repository. You will receive an automated email confirmation when this happens.
If you have any questions about the patch submission process, you can ask them either on the development mailing list, or in the IRC/Matrix channel.