GitHub Contributions - Step-by-Step (obsolete)

This documentation should be condiered obsolete. Please register with the EukMap application at http://eukmap.unieuk.org, if you plan to contribue to the UniEuk taxonomy.

This sections provides step-by-stop instructions including screenshots how to propose changes via GitHub.

Upload a new File

The preferred method to propose changes is to prepare an update file locally using Libre/OpenOffice, Excel, GoogleDocs or any other editor and upload the file to the contributions GitHub repository:

Upload File

Switch to the curated_subtrees folder and select Upload files from the Add file drop-down menu: github-workflow/workflow-upload_new_file.png

Commit Changes

This will open the GitHub upload-file-form which may be used to selected one or more files to be uploaded: github-workflow/workflow-upload_new_file2.png

Selected files will be listed in the form and my be removed before committing the changes. Committing the changes requires to specify a summary and description.

Create a new File / Modify File (alternative to: Upload a new File)

An alternative to upload files is to create a new file or to modify an existing file using the GitHub interface.

Switch to the curated_subtrees folder and select Create new file from the Add file drop-down menu: github-workflow/workflow-create_new_file.png

This will open a minimal editor to create the new file: github-workflow/workflow-create_change_file.png

Committing the new file requires to specify a summary and description.

Important: When creating new files or modifying files it is important to use tabs to separate columns and only one tab must be used as separator which means that columns will most likely not be aligned visually!

Pull Request

After committing the changes a pull request has to be created: github-workflow/workflow-upload_new_file_pull_request.png

Creating the pull request again requires to specify a summary and description. If the pull requests only includes a single commit the summary and description will be copied from the commit, otherwise the summary and description should updated to describe changes from all commits include in the pull request.