Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Track 0/9] GitHub setup #1

Open
taki-tiler-server bot opened this issue Sep 2, 2024 · 6 comments
Open

[Track 0/9] GitHub setup #1

taki-tiler-server bot opened this issue Sep 2, 2024 · 6 comments

Comments

@taki-tiler-server
Copy link

Taqtile - Onboard

Welcome to the Taqtile onboard. It will help you to get used to our technology stack, patterns and best practices.

Thoughout the onboard, you will develop a server able to:

  1. Store some data in a database (db)
  2. CRUD that data stored in db

Step 1/3 - Warming up - Mastering the Basics

Ok! Your first tasks will be given on next steps. But before moving on, let's be sure you know all the basics we use daily here.

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 a VSCode extension called GitLens. It's going to help you a lot with git by adding some functionalities to VSCode, including an extra view on activity bar (the icons on the left side).

GitLens

With Gitlens you'll be able (among other things...) to check who modifies the file and the prevision versions (previous changes) of that file, right in VSCode.

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.

In case of any issue, you can ask your tutor for help. Go to next step!

@GuiCastelo
Copy link
Contributor

Finish

Copy link
Author

Step 2/3 - Clone this repository

You can follow these steps in order to clone this repository:

  • Login to GitHub (if you don't have an account, create one here)
  • Go to this repository root page
  • Click on clone or download green button
  • Copy the URL and type the following command in Terminal:
$ git clone repository_link

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

@GuiCastelo
Copy link
Contributor

Finish

Copy link
Author

Step 3/3 - Git Flow

Before continuing, it's important to be familiar with our branch model and a few more 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 Vincent Driessen's branch model described here and we are going to 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 these:

  1. Feature branches are:

    • prepended with feature/ i.e. feature/new-user
    • 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. Bugfix branches are:

    • prepended with bugfix/ i.e. bugfix/user-list

@GuiCastelo
Copy link
Contributor

Finish

Copy link
Author

Click here for your next track

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant