Some hints on using GitHub for the PNG specification. Part two, changes to your pull request

Inevitably, someone will suggest changes to your pull request. Perhaps 
(a  purely theoretical example) you changed colour to color, but in a 
case-sensitive search so all the occurrences of Colour still need to be 
fixed. Whoops!

First we check that we are on the right branch:

git branch

This gives a list of all the various branches that exist, and puts an 
asterisk by the one you are actually on. Here is some typical output 
from that command, trimmed for brevity.

    apng-mime
    changes-since-20230720
* colour-to-color
    encoding-utf8

Great, we are in the right place. Now, someone else might have pushed 
changes to this branch so first be sure we are up-to-date

git pull --rebase

Now make our edits to improve our pull request, and save them. And 
finally, push.

git add index.html
git commit -m "Also change Colour to Color as needed"
git push

Enumerating objects: 5, done.
Counting objects: 100% (5/5), done.
Delta compression using up to 20 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 654 bytes | 26.00 KiB/s, done.
Total 3 (delta 2), reused 0 (delta 0)
remote: Resolving deltas: 100% (2/2), completed with 2 local objects.
To github.com:w3c/PNG-spec.git
    2fda349..7881483  colour-to-color -> colour-to-color


Notice that this time, git doesn't tell us off about upstream branches, 
we are all set. This new commit gets added to the changes we already 
did, so the pull request is now better than our first attempt.

Once it is reviewed, accepted, and merged, it becomes part of the 
specification.

-- 
Chris Lilley
@svgeesus
Technical Director @ W3C
W3C Strategy Team, Core Web Design
W3C Architecture & Technology Team, Core Web & Media

Received on Saturday, 13 January 2024 13:16:32 UTC