What is GitHub
GitHub is a web-based version control repository that is used to host and review code, manage projects and build software. Some of GitHub’s key features include -
- The use of repositories for each project to help host, version and release code; these repositories can be private or public,
- Built in code review tools,
- Supports the management of projects – assisting in focusing team efforts – in particular adding milestones to organise and track progress on groups of issues and assigning issues to distribute work,
- Along with these other features GitHub enables the creation of documentation i.e. documentation can be hosted directly from the repository or in a wiki – which includes version retention.
How do the AODN use GitHub
The AODN create repositories for each of the major software applications and use the repository to manage the code updates, review, documentation and the deployment for that application. Additionally the repository is used to track any bugs or issues with the application. The majority of the AODN repositories are public and AODN stakeholders and data contributors can review and add code, comments or issues directly into the repository.
In addition the AODN management use GitHub, in particular the Milestones feature, to manage the annual implementation plan and in conjunction with Scrum Methodology to prioritise the Development Team work.
What are the benefits to the AODN and data contributors
A few of the benefits of using GitHub for the AODN include –
- Continuous improvement in the quality of code,
- Provides a system to keep track of changes made throughout the coding process,
- The use of wiki’s and issue trackers for better documentation and feedback,
- The AODN can accept contributions from the community.