1. git

git best practices

Written by Posted on Less than 0 min read
11

While starting a project, you must follow some best practices. It can be naming convention, branching, git-flow, issue tracking, commit message, pull request and so on.

Today I will let you know the most & important one that we overlooked every time we started a project.

Project Naming Convention

Creating a repository requires a project or repository name, and you can enter an optional description of the repository if you want. The description and the repository name make it easier for people to find your project, so if you are working on a chat of an app using React Native, naming it something like “rn-chat-app” and providing a description like “A Chat application in React Native”, would make it easier for other people interested in creating chat app in React Native to find your project.

so you should use
rn-chat-app

Which breaks down into –
rn = React Native [you can use similar for Laravel. Example- laravel-chat-app]
chat = Main Product Name
app = Product Type [Example – app, web, API etc.]

Always use lowercase for project name with separator hyphen (-) only.

Commit Message

For writing commit message. Follow these rules –

  • Add | user profile & photo
  • Update | user profile photo check & filter method
  • Fix | user profile photo duplicate issue
  • Remove | user profile photo

Also, use a description where needed. For major features & updates

Short (72 chars or less) summary

More detailed explanatory text. Wrap it to 72 characters. The blank
line separating the summary from the body is critical (unless you omit
the body entirely).

Write your commit message in the imperative: “Fix bug” and not “Fixed
bug” or “Fixes bug.” This convention matches up with commit messages
generated by commands like git merge and git revert.

Further paragraphs come after blank lines.

  • Bullet points are okay, too.
  • Typically a hyphen or asterisk is used for the bullet, followed by a
    single space. Use a hanging indent.

Member since
Writing code for backend (PHP & MySQL) and love to play with the APIs. https://rdevs.xyz
Do you like Ashiqur Rahman's articles? Follow on social!

More from Ashiqur Rahman

  1. git
  2. gitlab

How to set up your SSH key for GitLab on macOS

One of the most common issues while getting started with Git and GitLab is setting up the private and public keys. Background The most common error you may get when trying to close a Git repository over SSH is this one: [email protected]: Permission denied (publickey,keyboard-interactive). fatal: Could not read from remote repository. What is SSH? […]
Written by
  1. git

git – move a commit between repositories

If you want to move a complete commit from one repository to another (and you don’t want to add it as a remote), you can use these steps: Create a patch In the source repository, create a patch based on the commit by running git format-patch SHA1_OF_COMMIT~..SHA1_OF_COMMIT Example – git format-patch c2d42a0583481652ce037b899beef45d9858b98f~..c2d42a0583481652ce037b899beef45d9858b98f (note the ~).This will […]
Written by
  1. Laravel
  2. Shared Hosting

Using Queues on cPanel Shared Hosting with Laravel

Sometimes, shared hosting must be used that does not permit the installation of supervisor to run the queue worker. A typical example of these are servers deployed with Cpanel access only. One approach for non-time-sensitive queue work (such as sending emails) is to add a task to the scheduler that starts the queue worker every […]
Written by
  1. Laravel

username / alphanumeric validation in Laravel

Laravel provide a rich set of pre-bult validation rules. If you need to validate alpha – numeric value you can use – alpha The field under validation must be entirely alphabetic characters. alpha_dash The field under validation may have alpha-numeric characters, as well as dashes and underscores. alpha_num The field under validation must be entirely […]
Written by
  1. Laravel

How to make Service & Repository Class generator for Laravel

Using Controller -> Service -> Repository -> Model pattern, we need to use custom service & repository class. By default Laravel included make:model & make:controller command. But to generate Service & Repository class, we need to create custom commands to generate these classes. So Let’s start. Service Class generator command 1st we need to generate […]
Written by
  1. Laravel

Laravel mail configuration test

To test the mail configuration of Laravel. Follow this simple steps – SSH into the server Run the tinker Artisan command to enter the Tinker environment Run this following command If tinker shows successful then check mail to ensure mail received properly. Otherwise tinker will throw error. Follow the error to solve the mail configuration. Ashiqur Rahman […]
Written by
  1. API
  2. Back-End
  3. Laravel
  4. PHP
  5. Uncategorized
  6. Web

Gmail SMTP config for cPanel

First, turn on the less secure app accessVisit – https://myaccount.google.com/lesssecureapps then in .env add these credentials switch the MAIL_PORT between (465 or 587) Test your Mail config Visit here laravel Ashiqur Rahman Member since May 11, 2018 Loading + Follow Following Writing code for backend (PHP & MySQL) and love to play with the APIs. […]
Written by
  1. AI

DALL·E: Creating Images from Text

DALL·E is a 12-billion parameter version of GPT-3 trained to generate images from text descriptions, using a dataset of text–image pairs. We’ve found that it has a diverse set of capabilities, including creating anthropomorphized versions of animals and objects, combining unrelated concepts in plausible ways, rendering text, and applying transformations to existing images. Recently, I got access to […]
Written by
  1. Best Practices
  2. Deployment
  3. Laravel

Config RDS connection for Laravel the right way | Best practices

I have faced RDS connection issues a lot. Cause AWS RDS used a different env variable rather than the Laravel default one for MySQL connection. So what is the best way to resolve the issue? Add this code on the top of your /config/database.php And change your MySQL connection to: Great! You are done! If […]
Written by
Next
No Comments
Leave a comment Cancel
Comments to: git best practices

Your email address will not be published. Required fields are marked *

Attach images - Only PNG, JPG, JPEG and GIF are supported.

Login

Welcome to rDevs
Brief and amiable onboarding is the first thing a new user sees in the theme.
Join rDevs
start writing