Github guidelines for working with i18n documents

The W3C Internationalization Activity has task forces which use github for document development. This page provides guidelines to help people contribute content if they are unfamiliar with github. Some of this information is a shameless copy of text from the Test the Web Forward documentation.

For the examples we will use the github username myUserName and we'll use a repository (repo) name, repoName. You should substitute your own username wherever you see myUserName, and the name of the repo you want to work with for repoName.

If you have comments or suggestions about how to improve this page, feel free to raise a Github issue.

See also the editorial guidelines.

Setting up github

If you haven't used Github before, follow the instructions in this section. Otherwise, skip to the next section.

  1. Create a GitHub account if you do not already have one, on github.com

  2. Download and install the latest version of Git: https://git-scm.com/downloads. Please refer to the instructions there for different platforms.

  3. Configure your settings so your commits are properly labeled:

    1. On Mac or Linux or Solaris, open the Terminal.

      On Windows, open Git Bash (From the Start Menu > Git > Git Bash).

    2. At the prompt, type:

      $ git config --global user.name "Your Name"
      

      This will be the name that is displayed with your test submissions

    3. Next, type:

      $ git config --global user.email "your_email@address.com"
      

      This should be the email address you used to create the account in Step 1.

    4. Then type:

      $ git config --global push.default upstream
      

      This ensures that git push will never unintentionally create or update a remote branch.

  4. (Optional) If you don't want to enter your username and password every time you talk to the remote server, you'll need to set up password caching. See Caching your GitHub password in Git.

Basic overview of how the process works

The repository that you contribute to will depend on the document that your task force is working on. For example, https://github.com/w3c/alreq. The following diagram illustrates the basics.

Diagram showing parts of the github setup.

We'll spend a moment in this section familiarising you with the basic setup. The following sections will indicate the detailed steps you need to take.

In a typical scenario, you will be working with an upstream repository (repo) that has a URL beginning with https://github.com/w3c/. This is the W3C repo – it is managed by the people who have editor access for your project, unless you are one of those people you don't have access to this, you can only propose changes to it. You will make a fork of that repo on github, which has a URL beginning with https://github.com/myUserName. A fork is basically just a copy of the W3C repository in which you can change things at will. It sits on the github server and from time to time will be referred to in this document as the origin.

Then you will typically clone your fork to a directory on your local computer, to make it easier to edit content with authoring tools and the like, however it is also possible just edit on the github site.

If you have cloned your fork to your desktop, you should update it regularly so that it matches the W3C repo. You do this by fetching the changes from the W3C repo to your local copy and merging them with what's on your hard disk. You'll then need to push those changes on to your fork on github, so that that is in synch too.

As you edit content files on your computer, you'll need to get them into your fork on github. To do this you need to select the files and add them (which basically just identifies them as ready for the next stage). Then you commit them, and finally you push them (upload them) to your fork.

Usually, prior to doing the add, commit, push routine, you would create a branch. This is rather like a walled garden within which you'll be making and managing changes. You can have any number of branches.

Once you have made changes and you want to send those for incorporation into the W3C repo, and once you have pushed those changes to your fork on the github site, you raise a pull request for the branch you were working in. The pull request informs the guardians of the W3C repo that you want to contribute some changes. Those guardians may simply merge your changes into the W3C repo, but typically they will look at your suggestions and allow some time for others to review them. You may need to change some things in the light of feedback before your content is merged with the W3C repo. Sometimes, the editors may take your code and add parts of it or add something along similar lines, rather than just merging the documents.

How to make your fork

Once you have Git set up, you will need to fork the test repository. This will enable you to submit your proposed changes using a pull request (more on this below).

  1. In the browser, go the the GitHub page for the W3C repository, ie. https://github.com/w3c/repoName/.

  2. Click the fork button in the upper right.

  3. The fork will take several seconds, then you will be redirected to your GitHub page for this forked repository, ie. https://github.com/myUserName/repoName/.

Cloning your forked repo to your desktop

If your fork was successful, the next step is to clone (download) a copy of your forked repo.

At the command prompt, use cd to get to a directory where you want to keep your fork. We're about to create a subdirectory within the directory you just moved to: the subdirectory will be called repoName, and will contain all the files for that fork.

Type the following:

$ git clone https://github.com/myUserName/repoName.git

where myUserName is your github username, and repoName is the name of the repository. This will download the forked repository into the subdirectory we just mentioned.

You should now have a full copy of the forked repository on your local machine. Feel free to browse the directories on your hard drive. You can also browse them on github.com and see the full history of contributions there.

Additional housekeeping

You should do a little housekeeping before going further.

  1. On the command line, navigate to the directory where your forked copy of the repository is located.

    $ cd <pathname>/repoName
          
        
  2. Make sure that you are on the gh-pages branch. This will be the case if you just forked. Type

    $ git status

    You should see several lines, one of which will say

    On branch gh-pages

    If you are on another branch, switch to gh-pages by typing

    $ git checkout gh-pages
    
  3. Next, check that git knows about the upstream repository you forked (ie. the W3C repo). This assigns the W3C repository to "upstream":

    $ git remote -v
    

    It should say

    origin      https://github.com/myUserName/repoName.git (fetch)
    origin      https://github.com/myUserName/repoName.git (push)
    upstream    https://github.com/w3c/repoName.git (fetch)
    upstream    https://github.com/w3c/repoName.git (push)

    If it doesn't, set upstream as follows:

    $ git remote add upstream https://github.com/w3c/repoName.git
    

Synchronising your local files and your fork with the W3C repo

You should regularly bring your local copy of the files up-to-date with the latest commits in the W3C repository.

  1. On the command line, navigate to the directory where your forked copy of the repository is located.

    $ cd <pathname>/repoName
          
        
  2. Make sure that you are on the gh-pages branch. This will be the case if you just forked, otherwise switch to gh-pages.

    $ git checkout gh-pages
  3. To pull in changes in the W3C repository that are not present in your local repository first fetch them:

    $ git fetch upstream

    Then merge them into the directories on your local system:

    $ git merge upstream/gh-pages
    
  4. Finally you will want to make sure that these changes get into your forked repo on github too. To do this, push the changes to your fork:

    $ git push

For additional information, please see the GitHub docs.

Making changes and proposing them

Now we describe steps to create content and how to request that the changes be merged into the content on the W3C repo.

Before you start on these steps, ensure that you have fetched the latest files from the W3C repo by following the steps in the previous section!

Also, ensure that you start from the gh-pages branch, otherwise you'll end up with a horrible nested mess and you'll be very embarrassed because someone will have to spend a while digging you out. You have been warned!

Create a new branch

At the command line, check you are on the gh-pages branch by typing

$ git status

If not, then type

$ git checkout gh-pages

Then create a new branch:

$ git checkout -b myBranchName

This will create a branch named myBranchName and immediately switch this to be your active working branch.

The branch name should describe specifically what you are working on. For example:

$ git checkout -b arabic-joining-forms

Make the changes to your content

Edit the files you want to change or create.

Prepare your files for submission

Before you submit your changes for review and contribution to the W3C repo, you'll need to first commit them locally, where you now have your own personal version control system with git. In fact, as you are making your changes, you may want to save versions of your work as you go before you submit them to be reviewed and merged.

  1. When you're ready to save a version of your work, go to the command prompt and cd to the directory where your files are.

  2. First, ask git what new or modified files you have:

    $ git status

    This will show you files that have been added or modified.

  3. For all new or modified files, you need to tell git to add them to the list of things you'd like to commit:

    $ git add [file1] [file2] ... [fileN]

    Or:

    $ git add [directory_of_files]
  4. Run git status again to see what you have on the 'Changes to be committed' list. These files are now staged.

    (Alternatively, you can run git diff --staged, which will show you the diff of things to be committed.)

  5. Once you've added everything, you can commit and add a message to this set of changes:

    $ git commit -m "New section on Arabic joining forms"

    Make the message as short but as informative as possible. Others will need to get a clear idea of what these changes are about by reading this text.

  6. Repeat these steps as many times as you'd like before you submit your changes for inclusion in the W3C repo.

Request that your changes be incorporated into the W3C repo

  1. The first thing you do before submitting changes to the W3C repo is to push them back up to your fork on the server:

    $ git push origin myBranchName

    Here, origin refers to your fork of the repo on the github server. You just use the word origin, git should know where that is. myBranchName should be the name of your branch that created earlier.

  2. Now you can send a message that you have changes or additions you'd like to be reviewed and merged into the W3C repository. You do this by using a pull request. In a browser, open the GitHub page for your forked repository, ie. https://github.com/myUserName/repoName/.

  3. Now create a pull request. There are several ways to create a PR in the GitHub UI. Below is one method and others can be found on GitHub.com

    a. Click on the new pull request button. You should see something like this:

    b. Pay careful attention to the line of buttons at the top of the picture above. Here's an example:

    Moving from left to right, the first button should say base fork: w3c/repoName, the second base: gh-pages, the third, head fork: myUserName/repoName, and the one on the right should read compare: myBranchName.

    Substitute the appropriate names for repoName, myUserName and myBranchName.

    If you see 'There isn't anything to compare', make sure your fork and your branch are selected on the right side.

    f. If you'd like to add more detailed comments or a title other than one that is suggested, edit the fields below the buttons.

    g. Click the send pull request button

  4. Wait for feedback on your pull request.

Modify your submission

Once you submit your pull request, a reviewer will check your proposed changes for correctness and style. It is likely that this process will lead to some comments asking for modifications to your code. When you are ready to make the changes, follow these steps:

  1. If you are no longer in the branch you were previously working on (in examples above this was myBranchName), check it out again, eg.

    $ git checkout myBranchName
  2. Make the changes needed to address the comments, and commit them just like before.

  3. Push the changes to the branch on your forked repo:

    $ git push origin myBranchName
  4. The pull request will automatically be updated with the new commit.

Sometimes it takes multiple iterations through a review before the changes are finally accepted. Don't worry about this, it's totally normal. The goal of review is to work together to create the best possible content for your task force.

Cleaning up

Once your pull request has been accepted, you will be notified in the GitHub UI and you may get an email. At this point, your changes have been merged into the W3C repo. You do not need to take any further action on the files you submittted, but you should delete your branch. This can easily be done in the GitHub UI by navigating to the pull requests and clicking the 'Delete Branch' button.

pull request accepted delete branch

Alternatively, you can delete the branch on the command line.

$ git push origin --delete myBranchName

Then fetch the latest files from the W3C repo and push them to your fork, as described earlier, so that you are up to date with everything.

Github hints & tips

See an HTML version of a page from a commit diff page

You're looking at the diff for a commit (eg. this one), and i want to see what the HTML page would look like. How do you do that?

  1. At the diff page, click on the View button

  2. Pick up the commit number from the address bar

    eg. 8be942ceb6ba109309f8371b7845011ed1ee63c1

  3. Open a browser window and go to the following URL, filling in the placeholders as appropriate:

    https://htmlpreview.github.io/?https://github.com/w3c/repoName/blob/commitNumber/fileName

So here's the HTML version of the page with the commit in the example at the start of this section.

Alternatively, you can point to files you have included in a pull request in your own fork (origin) using rawgit. Just construct the following URL: https://rawgit.com/w3c/repoName/branchName/path_and_filename.html

Publishing with Echidna

Follow these steps to quickly and easily publish your document to /TR space. It is good to keep differences between the editor's draft on github and version on /TR as small as possible. Echidna makes it possible to self-publish at any time, without having to wait for the webmaster's help.

Note that you can't publish First Public Working Drafts using Echidna. That has to go through the normal process.

Setting things up

Ask your staff contact to do the following:

  1. Get a token for your spec from the W3C. You'll need to keep this somewhere safe for when you want to publish the document.

  2. Set the w3cid variable inside the document for the editors who will be doing the actual publication.

  3. Add a config file for the document on github.

Actually publishing

Follow these steps:

  1. Check that the github.io Editor's Draft (ED) is valid HTML using the HTML5 validator.
  2. Check that all links work using the W3C Link Checker.
  3. Run a spell checker over the document.
  4. Update the config file for the document so that it lists all images and other dependant files. The config file will be at the top level of the GitHub repo, and usually has the name of the document, without an extension.
  5. Go to the Pubrules checker and run it against the following URL:
    https://labs.w3.org/spec-generator/?type=respec&url=https://w3c.github.io/linkToYourSpec/?specStatus=WD;shortName=theShortName
    Fix anything that's needed, and rerun the checker until it's ok. You will probably find that the checker complains about not being able to find a dependent file (usually the .css file). That's because the URL above creates a WD version of your main file in a new location for testing, and doesn't copy over the dependent files. You can ignore those messages, but you should double-check that the config file lists all dependent files.
  6. Open a terminal window and run the following Curl statement:
    curl 'https://labs.w3.org/echidna/api/request' --data 'url=echidnaConfigURL&decision=decisionUrlOnMailingList&token=documentToken'
  7. Go to the TR-Notification list to check whether the document was successfully published.