Skip to content

Make a glossary change

Dᴼᴷᵀᴼᴿ D. ᵂᵁᴺᴰᴵᴮᴬR edited this page Mar 7, 2017 · 9 revisions

Note: To do anything described on this page, you should have already walked through the steps under the How to contribute section on the wiki homepage.


As explained in collaboration levels, glossary editors can commit (push) changes directly to the master repository, while definition writers must request to have their changes merged (a pull request).

Either situation requires having some changes ready to be added to the master repository. So, we'll explain the push and pull request scenarios by adding a new draft to the master repository, which benefits the repository development stage we're currently in, as described in Project development phases

Port a draft file to your repository clone (writers and editors)

This will be the same process regardless if your an editor or a writer type of collaborator.

Adding a new file to the repository qualifies as an uncommitted change, whether or not any changes are made to the file itself. Not all changes have to be done at once. The files can be edited further anytime after the initial commit to the master repository.

With your Markdown-compatible text editor ready, try this:

  1. Go to the Glossary terms register, pick a term from the list in the Target terms tab, and follow the associated draft link. (This will open the old G-doc draft file in Google Drive.)
  2. Copy the content of the G-doc file, if there is anything to copy, and paste it into a new file created with the Markdown editor.
  3. Save the file in .md format to your clone directory. Name it using the term the draft file is for, and use hyphens (not underscores) in place of any blank spaces (e.g., "pair-writing.md").

Jump back to your Github client. The text on the clone files context button should now read 1 Uncommitted Change. The 1 is referring to the file you just added into your cloned glossary repo. It means your clone is working correctly. You now have a change ready to commit by either push or pull request.

Switch into clone files content, if not already there, by clicking the 1 Uncommitted Change button in the toolbar. The .md file you added will appear in the file list (the only file listed) and be active by default, you'll see the contents of the file in the file display.

The display shows your file content highlighted in green only at this point, because you've added a new file, so the entire file is a "new" change. If this had been a file previously committed to the repo and you edited it afterward, unchanged regions would be in white, changed-from regions would be in red (i.e. the stuff you edited), and change-to regions would be in green (i.e. the stuff you changed the red regions to).

At this point you could add another file or more using the steps above. Each file would appear in the file list, and the context button would adjust to reflect the uncommitted file count. You could then uncheck the boxes by these files as you wish so that only checked files will be committed to the master repo.

Now we divide by access rights. Contributing writers should move to the following section for pull requests, and editors should move to the section after about push commits.

Commit (push) directly to master repository (editors)

For collaborators with rights to commit changes directory to the master repo, and have changes ready to commit, do the following:

  1. Click the Sync button in the top right of the client window to sync any new master changes to your local clone. (This avoids conflicts between clone and master.)
  2. Switch files view to clone context (uncommitted changes context).
  3. Check the box next to the file(s) to be committed.
  4. In the Summary field at bottom of the file list, add a short note (e.g. "{term} draft file added"). Skip the Description field.
  5. Click the Commit and Sync master button.

It may take a moment or two, but if the commit works, the uncommitted file(s) will disappear from your files list, meaning they have successfully synced upward (committed) to the master. You just did a successful push to a repo!

Request (pull request) to have your changes merged (writers)

(steps needed)

Clone this wiki locally