To make it as easy as possible to help you with coding, we set up a Crucible server on our DigInG server:
http://diging.asu.edu/fisheye
The following short posts are designed to give you information about what we think you need to know working on our projects. We will continue to add information as we go along, and welcome any feedback about understandability or missing information. We hope this site will act as a clearing house for DigInG information and will make your life a little easier. :)
To make it as easy as possible to help you with coding, we set up a Crucible server on our DigInG server:
http://diging.asu.edu/fisheye
We use the GitHub Issues tracking system for bug reporting and feature requests. If something doesn’t behave as expected when you’re using our software, you should report it by creating a new issue on that project’s GitHub page.
All of our Python projects should include a comprehensive array of tests. For unit tests, we use the built-in Python unittest framework.
Git is a Version Control System that is widely used in software development projects. A VCS helps developers keep track of changes to source code over the course of a project. We use Git for all kinds of projects, not just for managing source code. A solid working knowledge of Git is essential for both researchers and developers in DigInG.
For Python projects, we will follow the PEP8 Style Guide for Python Code.
We use several different issue tracking systems for our projects. Depending on what project you are working on, you will need an account in Jira and/or Pivotaltracker. Once you have created an account let us know what your username is and we will add you to our projects.
Most of our projects are hosted on GitHub. In the beginning of the class you will learn how to use Git and GitHub. You will therefore need an account on GitHub. Please create your account by registering here. Choose the free plan and don’t create an organization. We will add you to the DigInG organization, once you start working on our projects.
In DigInG we follow an agile methodology, specifically Scrum. You will work in small teams, which each has:
A few DigInG projects are hosted at SourceForge and use Subversion as version control system. However, most projects are hosted on GitHub and you will most likely interact with GitHub and Git in your projects. We will use the “Gitflow Workflow” described in this article. Please read it carefully, you will be expected to follow the described procedure. The most important points for you are:
In the Digital Innovation Group, we follow Continous Integration principles as much as possible. We are still in the process of setting up the infrastructure, but ideally all projects will use the following components.
For Java code, we will follow Google’s code style guidelines. Please read up on the guidelines. The only rule we change is the indentation. Instead of an indentation of 2, we use 4 spaces to indent the next level.