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

Intenal-SOP_TrainBooking #28

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

AmeyaBhargava
Copy link
Contributor

Description

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation Update (if none of the other choices apply)

🚨 Checklist:

  • Make sure you are requesting to pull your topic/feature/bugfix branch (right side). Don't request your master!
  • Make sure you are making a pull request against our dev branch (left side). Also, you should start your branch off our dev branch.
  • Your code follows the code style of this project.
  • Your change requires a change to the documentation.
  • You have updated the documentation accordingly.
  • You have read the Contributing Guide.
  • You have self-reviewed your code.
  • You have added unit-tests that prove my fix is effective or that my feature works.
  • Lint and unit-tests pass locally with your changes.
  • You have added necessary comments for complex logic.
  • Any dependent changes have been merged and published in downstream modules.

Further comments

🙏 Thank you!

Thank you for contributing to this project. We appreciate your time and effort. 🎉

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @AmeyaBhargava, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request introduces a new help document, _help/Eko Internal Procedure For Regustering.md, which outlines the internal standard operating procedure (SOP) for train booking. The SOP covers steps from ensuring agent email mapping to Zoho ticket management, assisting agents in obtaining MAC addresses and Device IDs, emailing the MOS team for ID activation, and notifying the MOS team after Aadhaar verification.

Highlights

  • New SOP Document: A new markdown file _help/Eko Internal Procedure For Regustering.md is added to document the internal SOP for train booking.
  • Agent Email Mapping: The SOP starts by ensuring the agent's email is correctly mapped within the Zoho system.
  • MAC Address and Device ID Retrieval: The SOP provides detailed instructions on how agents can obtain their MAC address and Device ID using the command prompt.
  • MOS Team Communication: The SOP outlines the process of emailing the MOS team with necessary agent details for ID activation, including a sample email format.
  • Aadhaar Verification: The SOP emphasizes the importance of notifying the MOS team after successful Aadhaar verification to proceed with ID activation.

Changelog

  • _help/Eko Internal Procedure For Regustering.md
    • Created a new markdown file to document the internal SOP for train booking.
    • Added steps to ensure agent's email is mapped with the account using Zoho form iframe.
    • Included instructions to manage Zoho ticket creation automatically upon email submission.
    • Provided methods to assist agents in obtaining MAC Address and Device ID using command prompt (CMD).
    • Outlined the process to email MOS Team for ID Activation with required agent details and a sample email format.
    • Specified the need to notify MOS after Aadhaar verification is completed.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


A new SOP, a guiding light,
To book those trains, and do it right.
From email checks to MAC address,
Success is found with each process.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new SOP document for train booking, detailing the steps for agents to follow. The document covers email mapping, ticket creation, obtaining MAC address and Device ID, emailing the MOS team for ID activation, and notifying MOS after Aadhaar verification. The document is well-structured and provides clear instructions with supporting images.

Summary of Findings

  • Inconsistent use of bold text: The document uses bold text inconsistently, sometimes for headings and sometimes for emphasis within the text. According to the style guide, headings should not be bold, and bold text should be used to highlight key terms in the body text only.[^1]
  • Grammar and Spelling: There are some grammatical and spelling errors that need to be addressed to ensure the document is professional and easy to understand. [^2]

Merge Readiness

The SOP document provides valuable information for agents. However, before merging, the issues related to the inconsistent use of bold text and the grammatical/spelling errors should be addressed. I am unable to approve this pull request, and recommend that others review and approve this code before merging.


### Steps to Find the **MAC Address** Using Command Prompt (CMD)

**Method 1: Using `getmac` Command**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

According to the style guide, headings (H1, H2, H3) should not be bold. Please remove the bold formatting from this heading.1

Style Guide References

Suggested change
**Method 1: Using `getmac` Command**
Method 1: Using `getmac` Command

Footnotes

  1. No bold in H1, H2, and H3 headings. The H1, H2 & H3 headings should remain plain text without any bold formatting. (link)


![DEVICE ID](/empages/images/help/Internal SOP - Train Booking/IP2.png)

3. To obtain **MAC address** of active network adapters write the following command **getmac \v \fo list**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There is a grammatical error in this sentence. Consider rephrasing for clarity. Also, remove the bold formatting from this heading as per the style guide.[^1,2]

Style Guide References

Suggested change
3. To obtain **MAC address** of active network adapters write the following command **getmac \v \fo list**
To obtain the MAC address of active network adapters, write the following command: `getmac \v \fo list`

3. To obtain **MAC address** of active network adapters write the following command **getmac \v \fo list**
![MAC address of active network adapters](/empages/images/help/Internal SOP - Train Booking/IP3.png)

**Method 2: Using `ipconfig /all` Command**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

According to the style guide, headings (H1, H2, H3) should not be bold. Please remove the bold formatting from this heading.1

Style Guide References

Suggested change
**Method 2: Using `ipconfig /all` Command**
Method 2: Using `ipconfig /all` Command

Footnotes

  1. No bold in H1, H2, and H3 headings. The H1, H2 & H3 headings should remain plain text without any bold formatting. (link)

4. The **Physical Address** listed is your **MAC address**.

![To find mac address of device](/empages/images/help/Internal SOP - Train Booking/IP4.png)
### **Notes:**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

According to the style guide, headings (H1, H2, H3) should not be bold. Please remove the bold formatting from this heading.1

Style Guide References

Suggested change
### **Notes:**
### Notes:

Footnotes

  1. No bold in H1, H2, and H3 headings. The H1, H2 & H3 headings should remain plain text without any bold formatting. (link)


Kindly help in activating the IRCTC ID for the following user as per the attached details:

**User Details:**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

According to the style guide, headings (H1, H2, H3) should not be bold. Please remove the bold formatting from this heading.1

Style Guide References

Suggested change
**User Details:**
**User Details:**

Footnotes

  1. No bold in H1, H2, and H3 headings. The H1, H2 & H3 headings should remain plain text without any bold formatting. (link)

Mobile Number: 7037470402
CSP Code: 36305001

**Additional Details:**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

According to the style guide, headings (H1, H2, H3) should not be bold. Please remove the bold formatting from this heading.1

Style Guide References

Suggested change
**Additional Details:**
**Additional Details:**

Footnotes

  1. No bold in H1, H2, and H3 headings. The H1, H2 & H3 headings should remain plain text without any bold formatting. (link)

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

Successfully merging this pull request may close these issues.

1 participant