PROJECT_GUIDELINES.MD

Project Guidelines

Note: This guide will act as a set of rules, that are required to be followed by anyone who is contributing into this project. If you have a better way, then feel free to raise an issue against that particular guideline

• Use simple names for files or folders and keep the pattern consistent

• Write clean code

• We are following the Airbnb Style Guide

Important points

1. Branch name should follow this format: (type)/(small-description)

   Type	Example	Commit Prefix
   Feature	feature/small-description	feat:
   Bug	bug/small-description	fix:
   Hot Fix	hotfix/small-description	fix:
   Docs	docs/small-description	docs:

2. Make sure to create new branch for every ticket.

3. Prefix your commit messages with fix:, feat:, or docs:

4. Write meaningful commit messages, will prefer if every commit also includes ticket number.

5. PR should include ticket url and proper description.