-
Notifications
You must be signed in to change notification settings - Fork 0
Quickstart for writers
We assume you have the necessary GitHub account already. Create one now if not.
Then do the following, which should take about 5 minutes:
- Download and install the Github Desktop Client.
- Open the client and connect to GitHub using your account credentials when prompted.
- Clone the master repository.
- Create a local branch from your clone and name it "my-drafts".
Congrats! You're setup locally. You don't have to do that again. The following diagram shows the workflow relationship between your computer and the master repository at GitHub.
Now take some time to review the desktop client layout and features to get familiar with your GitHub client application. By doing step 3 above, you'll have some context by which to look at things better.
In relation to the diagram above, your regular workflow routine will be:
- Sync the master state down to local clone.
- Sync local clone down to the "my-drafts" branch. (By this point your local branch directory is the same as master.)
- Make file changes as desired in local branch. (Using your computer's file manager and a text editor.)
- When ready, make a pull request to the master repo to have local branch changes reviewed and merged.
Repeat steps 1–4 every time you intend to share changes — in that order!
Using issues is imperative to the collaboration process too for the communication side of things. You'll use them to propose glossary changes, discuss/debate proposals, indicate the status of drafts, challenge editors (respectfully), and so forth.
Now you can make a glossary change in relation to the first stage objectives. Be sure to start a history thread using issues for whatever term or definition you work on.
Mind the style guidelines.
README | Glossary index | Terms register (temporary)