Project Dragon Fruit – Part 3: Creating a repository

  • by

Hi Guys, Jacob here again.

  • In Part 1 we looked at the basics of using trello for project management.
  • In Part 2 we looked at creating tickets and epics in Trello

Today we’re going to look at setting up a repository – a place where we can store our code.

It’s the first step in setting up the platform which we will code from – a collection of applications and tools that we will be using to help build and run our code.

Whether you are working on a project individually, or as part of a group, you are going to want a repository (repo). This will allow everyone to work separately on their coding while keeping it securely backed up in the repo. Your group will be able to access the repo to pull down (update) changes to the code that another team member makes. This means that you and your team are always working on the most up to date version of the project.

I am going to use GitHub. For a small project like mine, the free repos on GitHub have plenty of space and the integration with development environments (Programmes which act like word processing, but for code. They let you write and edit source code, but also come with a whole host of different add ons such as autocomplete and debugging) allows for your team to control the repository from directly within your project. The first thing to do is head over to https://github.com/ and create an account:

Once signed in you will be greeted with your home screen. This will be fairly empty for the time being. On the left you will see a list of the repos that you are a member of and in the centre you will get activity updates from repos that you are a member of or following.

Click on the “new” button in the top right of the repositories sidebar:

This will take you to the repo creation screen which allows you to name, describe and choose some presets for your repo:

We are going to set it to ‘private’ which means that only people with invitations can view it. We will choose to add a README – a document setting out basic rules and aims of the project and a .gitignore file – a place where you can list files that you don’t want your repo to store or update, mainly things that your compiler automatically generates when you run your program in an integrated development environment. I’ll be using the one for VisualStudio (the development environment I’m using), but there is a list of options depending on what language you are coding in.

Once you have filled in the details click the create repository button at the bottom of the page.

You should now see your repo containing the README file and the .gitignore file:

Now add everyone who needs to access your work. To do this go to settings → manage access and add collaborator:

Finally, under Branches, we can set up any branch protection rules such as making sure that any new code that requests to be merged into your main program is checked over by another member of the team – this will ensure that it is not going to introduce any bugs (coding flaws that mess up your main code). In other words, it prevents people from uploading their work without having someone proof-read it.

To do this go to Branches and click add rule:

There are a number of predefined rules that can help to control and maintain your code integrity. We are going to select the option to require a review. You can select to have up to 6 reviewers sign off on a piece of code before it is merged with the main program.

We now have our repository set up and read to go!

Next time, we will look at how to “clone” your repo to your local machine; how to push and pull your code and what that means.

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.