may-frontend-suit-up-1

Getting Started

Clone this repository (ensure that your ssh connection is properly setup).
Make sure to have prettier installed in your code editor.
Also make sure to have the pesticide browser extension installed in your browser.

Naming Conventions and Best Practices

It is important to follow proper naming conventions and best practices when working on this project. This will help us maintain a clean and readable codebase. This also helps us to avoid merge conflicts and other issues that may arise from improper naming conventions.

Naming Conventions and How to Complete a Ticket

When working on a ticket, you need to make sure that you first have the latest changes from the master branch. To do this, run the following commands:

git checkout master

git pull origin master

After pulling the latest changes from the master branch, you can now create a new branch to work on your ticket. To create a new branch, run the following command:

git checkout -b <branch-name>

The <branch-name> should be in the following format:

<your-name>/<ticket-number>-<ticket-title-or-description>

For example, if you are working on ticket CO-120 and your name is John Doe, then your branch name should be:

johnDoe/CO-120-hero-section

After creating your branch, you can now start working on your ticket. When you are done working on your ticket, you can now push your changes to the remote repository. To do this, run the following commands:

git add .

git commit -m "[<ticket-number>] - <commit-message>"

For example, if you are working on ticket CO-120 and you have implemented the HTML markup for the hero section, then your commit message should be:

git commit -m "[CO-120] - Implemented HTML markup"

After committing your changes, you can now push your changes to the remote repository. To do this, run the following command:

git push origin <branch-name>

For example, if you are working on ticket CO-120 and your branch name is johnDoe/CO-120-hero-section, then you should run the following command:

git push origin johnDoe/CO-120-hero-section

After pushing your changes to the remote repository, you can now create a pull request. To do this, go to the repository and click on the Pull requests tab. Then click on the New pull request button. Make sure that the base branch is master and the compare branch is <branch-name>. The format of the title of the pull request should be:

[<ticket-number>] - <ticket-title-or-description>

For example, if you are working on ticket CO-120 and you have implemented the HTML markup for the hero section, then the title of your pull request should be:

[CO-120] - HTML markup for hero section

Make sure to assign yourself to it and add your teammates and team lead as reviewers. After that, click on the Create pull request button and update the ticket on Lokum with the link to the pull request.

Best Practices

Do not wait until the whole task is completed before you push a commit. Break down your task into smaller chunks and push a commit once a chunk is completed.

PREREQUISITES

You must have completed the following catalogs: