How to work on the Codetables

NOTE: This page is out of date and needs revision.

Preface

• Attention: We only work with CSV in UTF-8!

• For an illustration and explanation how the workflow in this Github works, read here.

• Try to stick to the following rules when altering or creating a new table.

How to work on a branch? – e.g. alter a table

1. Update your local repository (e.g. use sync or pull).

2. Go to branches, choose the branch related to your issue, open folder "tables_en".

3. Open table in excel, if the table is not appropriately displayed, check your language settings (control panel-->region and language-->formats-->settings-->list separator).

4. Alter table, save as CSV (comma delimited).

5. Check in Notepad++ (or alternative editor) if the delimiter is correct and the encoding is UTF-8.

6. If you want to work on your document before ‘publishing it’ you can choose to make commits without syncing. This will allow you to have version control whilst keeping the changes local to your computer initially.

7. Push your local GitHub Repository to the online/published Repository (this can be done via sync on GitHub Desktop). Enter a short message, this message will be displayed on Github in two ways:

8. Your branch can be merged to the development branch after the issue is closed by the Co-chairs and the changes are approved.

Advanced: Labels and other functionalities of an issue

If we follow the workflow described here our list of issues becomes very long in a very short time. We can group them by using labels to arrange it more clearly. You can add a label to an issue the following:

1. Open the issue.
2. Click on "Labels" on the right side.
3. Choose an existing label or create a new one (just start typing). This label will appear as colored box behind the issue name in the list of the issues. Furthermore, we can search by labels. Use the label: discussion required for issue that need to be discussed within TT-WMDS. Use the label: Technical change/typo if it is only a small technical or typo change which does not need to be discussed.

If an issue is completed and merged into the developer branch we can close it by clicking on ‘Close issue’. In case it had the label "discussion required" remove this label. We still can find this issue if we select ‘Closed’ at the top of the list.

How to compare a branch with the master in GitHub?

You want to see quickly what changes where made in this branch in comparison to the master: Go to the GitHub repository, select the branch and open the folder tables_en.

Click on 'compare'. Now the changes and the commits done to this branch are displayed.

The result will look similar as in this example:

Attention: If you compare two branches, then the base branch will be as it was in the beginning (ignoring the changes you commited since then).

How to create release of master branch

More information :

• GitHub user documentation
• Example  

1. On GitHub, navigate to the main page of the repository.

2. Under your repository name, click on "Releases".
3. Click "Draft a new release".

4. Type a version number for your release. Versions are based on Git tags. We recommend naming tags that fit within semantic versioning.
5. Select a branch that contains the project you want to release. Usually, you'll want to release against your master branch, unless you're releasing beta software.
6. Type a title and description that describes your release.
7. If you'd like to include binary files along with your release, such as compiled programs, drag and drop or select files manually in the binary box.
8. If the release is unstable, select "This is a pre-release" to notify users that it's not ready for final use.
9. If you're ready to publicize your release, click on "Publish release". Otherwise, click on "Save draft to work on it later" (then you can continue at a later point).