github

Github and Code Repositories

• Introduction
• Opening a GitHub Account and & Setting Up Git

Introduction

All code generated at SPIRAL should be at a quality level that allows for worldwide dissemination. As a member of SPIRAL, you will not be writing code for yourself; you will be working as part of a team. Consequently, it is expected that you follow the coding practices and standards of the group. You must learn quickly from others and teach others if you have something useful and interesting to contribute. All project codes must be maintained in a version controlled repository. Our aim is to collectively grow our project specific code collections and generic tool libraries, for the purpose of producing reproducible scientific results.

If another reasonably knowledgeable and capable person cannot (1) use your code and replicate your results, (2) make modifications to your code to allow for its application to alternative problems and datasets, your code is useless. Always strive to learn how to write better code and how to improve our collective product. All codes will be disseminated to the public over the internet with appropriate credit to all contributors. These can (1) improve your impact on science and society, (2) showcase your work and capabilities to potential future employers.

Opening a GitHub Account & Setting Up GIT

1. Open a GitHub account at https://github.com using your ECE.NEU.EDU email (at any time, you can associate more email addresses with your account, however having the ECE email as primary makes it easier for other SPIRAL members to invite you to join repositories – use your ece email address).

2. Get invited to the neu-spiral organization. You need an invitation to join; ask your advisor if you have not already received one. Doing so will give you access to SPIRAL resources, including this wiki.

3. Read the GitHub documentation.

4. You have a couple of different choices for GIT software on your computer.

   a. GIT GUI. (Also has the GIT Bash option) Note that when merging different versions, unresolved conflicts will cause extra text to be inserted in the code file, and this breaks the code. Do not leave any conflicts unresolved when committing.

   b. GIT Extensions. This option is preferred by some CSL users.

   c. Command line (GIT Bash), more complete and more advanced, but may require GIT proficiency. This option is preferred by some CSL users.

   You can use any GIT software you want as long as you make sure everything is working correctly.

5. Remember to assign your full name (First Last) and ECE email address correctly in any GIT software you use. When you commit a code to a repository these credentials are used to show who committed the code.