indigotech / onboard-gustavo-matsumoto

0 stars 0 forks source link

[Track 0/8] GitHub setup #1

Open taki-tiler[bot] opened 2 years ago

taki-tiler[bot] commented 2 years ago

Taqtile - Onboard

Welcome to the Taqtile onboard. The main goals of this onboard are:

  1. Learn the basics about some concepts by building your own application/website
  2. Get you ready for a real project by presenting some of our tech stack and best practices

Step 1/3 - Warming up - Mastering the Basics

Ok! Your very first tasks are to clone this repository into your own account and create the README.md file.

But before moving on, let's be sure you know all the basics we use daily here.

First, we use git... a lot. If you don't feel confident in your skills using git, here are some recommendations:

If you don't have it already, we recommend you to install the GitLens VSCode extension. It's going to help you a lot with git by adding an extra view on activity bar (the icons on the left side).

GitLens

It will help you to check the modified files, as well as the changes on each of them.

Even though this extension has some tools to perform git commands, we highly encourage you to use the terminal, and use the extension as a visual guide to your changes.


At the end of every task of this onboard, comment the word Finish on the issue to receive your next task (you can try reloading the page if it's taking too long). You can also comment the word next, in case you had to skip the current task.

If you face any problem with the onboard, you can ask your tutor for help.

ggm801 commented 2 years ago

Finish

taki-tiler[bot] commented 2 years ago

Step 2/3 - Clone this repository

Follow the steps below in order to clone (download) this repository:

$ git clone repository_link

When you're done, the git will clone (download) the entire project into the folder you're running the terminal.

ggm801 commented 2 years ago

Finish

taki-tiler[bot] commented 2 years ago

Step 3/3 - Git Flow

Before continuing, it's important to be familiar with our branch model and a some git tricks.

Branch model

When working in teams, it's crucial to coordinate the parallel work of all team members.

In order to improve our workflow, a few years ago, we've adopted the Vincent Driessen's branch model described here. So let's use this same branch model during our onboard.

Git Flow

git-flow is a tool that helps to follow Vincent Driessen's branch model. You can use it though it's not necessary.

Our conventions

There are a few conventions we use here and it's important for you to be aware of them:

  1. Branches that introduce new features are:

    • prepended with feature/ i.e. feature/login-screen
    • should have meaningful names - they should give good hints about what modifications to the system they have
    • should not have your name on it
  2. Branches that fix a bug are:

    • prepended with bugfix/ i.e. bugfix/login-screen-animation
ggm801 commented 2 years ago

Finish

taki-tiler[bot] commented 2 years ago

Click here for your next track