From 3c1de0c5fe7a1ed543c459147b6771ef2d10706e Mon Sep 17 00:00:00 2001
From: Flying-Pegasus <atulya1804@gmail.com>
Date: Mon, 9 Dec 2024 10:56:49 +0530
Subject: [PATCH] Update README.md

Provided a clear description of where to add the repo name in the constant.js file.
---
 README.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9cdc0853..c7c3ee5f 100644
--- a/README.md
+++ b/README.md
@@ -79,7 +79,36 @@ from .env file, Otherwise app will not work locally.
 
 ## Installing the bot on a repository
 
-You'll need to identify a target repository and install the bot by clicking the **Install** button on the settings page of your app, e.g `https://github.com/settings/apps/my-oppiabot-testing-app/installations`. In the `.env` file put your github account name in `WHITELISTED_ACCOUNTS` and also add your repository (name in small caps) in the `constants.js` file locally.
+1. Identify a target repository and install the bot by clicking the Install button on the settings page of your app, e.g., **`https://github.com/settings/apps/my-oppiabot-testing-app/installations`** 
+2. Update the **`.env` file**:
+   - Add your GitHub account name to `WHITELISTED_ACCOUNTS`.  
+3. Add the repository name in the **`constant.js` file**:  
+   - Open the **`constant.js`** file in the bot's source code.  
+   - Navigate to the `checksWhitelist` object.  
+   - Add a new entry with your repository name (in lowercase) as the key. The value should define the checks and events specific to your repository.  
+
+   **Example:**
+   If your repository name is `my-repo`, the `checksWhitelist` object will look like this:  
+   ```javascript
+   const checksWhitelist = {
+     // Existing entries...
+     'my-repo': {
+       [openEvent]: [claCheck],
+       [reopenEvent]: [],
+       [openEventGithubActions]: [claCheckGithubAction],
+       [reopenEventGithubActions]: [claCheckGithubAction],
+       [synchronizeEvent]: [mergeConflictCheck],
+       [closeEvent]: [allMergeConflictCheck],
+       [editEvent]: [],
+       [issuesLabelEvent]: [],
+       [issuesAssignedEvent]: [],
+       [pushEvent]: [],
+       [pullRequestReviewEvent]: [pullRequestReviewCheck],
+       [issueCommentCreatedEvent]: [respondToReviewCheck],
+     },
+   };
+   
+4.Save the changes to **`constant.js`**.
 
 
 ## Running the bot locally