Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 4.34 KB

development-guide.md

File metadata and controls

108 lines (73 loc) · 4.34 KB
Raw

Table of Contents

  1. Wireframe
  2. Database schema
  3. Task Creation on Kanban
  4. Branch Naming Convention
  5. Creating a Pull Request on GitHub

Wireframe

View Details

Homefront

The login page The user profile page
The home page The room detail page
-- --
The reservation page

Merchant App

The login screen The signup screen
The forget password screen The room listing screen
-- --
The room detail screen The create and update room screen

Database schema

View Details

The below database schema is designed by using dbdesigner. You can import this file room-booking.dbml into dbdesigner to visualize the db schema like the below image.

Database schema

Task Creation on Kanban

When creating a new task on the Kanban board, use the following naming structure for clarity and consistency: Convention

[<ServiceName>]<Task name>

  • ServiceName: The name of the service in square brackets.
  • Task name: A brief description of the task.

Example

For a task related to the Listing Service for updating the guideline document, the task name would be:

[Listing Service] Update guideline document

By following this structure, we enhance the readability and organization of our Kanban tasks, making it easier for the team to prioritize and manage work.

Branch Naming Convention

To maintain consistency and clarity in our branching strategy, we follow a specific naming convention for feature branches. This helps all team members understand the purpose of a branch at a glance.

Convention

feature/nodejs-msa-<itemid>-<title slug>

  • feature: Indicates the type of branch (in this case, a feature development).
  • nodejs-msa: Refers to the microservice architecture project for Node.js. : The unique identifier for the feature or task, such as a ticket number or item ID.

Example

For a task with item ID 1234 and a description Add login functionality, the branch name would be:

feature/nodejs-msa-1234-add-login-functionality

How to Obtain the Item ID?

Get Task Item ID

Creating a Pull Request on GitHub

After you've pushed your branch to the remote repository, follow these steps to create a pull request on GitHub: Navigate to the repository on GitHub.

  1. Go to the "Pull requests" tab.
  2. Click the "New pull request" button.
  3. Select the branch you created from the list of branches. This will be the branch you want to merge into the main branch.
  4. Provide a clear and descriptive title for the pull request. Typically, the title should match the branch name.
  5. Fill in the description with details about what changes are being proposed. Include context, screenshots, and references to related tasks or tickets.
  6. Assign reviewers, labels, or projects if necessary.
  7. Click the "Create pull request" button.

Following these steps ensures that your pull request is properly documented and ready for review by your team.

Example

Create a pull request

The steps to create a pull request can be broken down as follows:

  • Title: The title of the task from GitHub Projects or project management tool.
  • Description: "This pull request adds login functionality to the Identity service..."

By following this structure, you make it easier for your team to understand and review your contributions.