Update the readme me file

[HardikGoyal2003]

Is your feature request related to a problem? Please describe.
Readme file's this heading doesn't provide a clear description of where to add the repo name in the constant.js file.

Describe the solution you'd like
Add the description

Describe alternatives you've considered

Additional context

[ayyushx]

@HardikGoyal2003 PR made to this issue, please review it and suggest changes, if required.

[Flying-Pegasus]

I am interested in solving this issue, please assign it to me. @HardikGoyal2003

[HardikGoyal2003]

@Flying-Pegasus Per the guidance at https://github.com/oppia/oppia/wiki/Contributing-code-to-Oppia#choosing-a-good-first-issue, please provide an explanation of what your PR will do (with names of files you're changing, what you plan to change in each file, etc.). If it looks good, we can assign you to this issue.

Please also follow the other instructions on that wiki page if you have not yet done so. Thanks!

[faryalRiz1]

hi @HardikGoyal2003 ,
I’m interested in working on the issue about clarifying the README instructions for adding the repository name in constants.js. Could you please assign it to me?

[HardikGoyal2003]

@faryalRiz1 Per the guidance at https://github.com/oppia/oppia/wiki/Contributing-code-to-Oppia#choosing-a-good-first-issue, please provide an explanation of what your PR will do (with names of files you're changing, what you plan to change in each file, etc.). If it looks good, we can assign you to this issue.

Please also follow the other instructions on that wiki page if you have not yet done so. Thanks!

[Flying-Pegasus]

Proposed Update for the README.md File

I would like to update the README.md file to provide clear and detailed instructions on where and how to add the repository name in the constant.js file. Below is the breakdown of the planned changes:

Files to be Updated

• README.md .

Proposed Changes

1. Existing Problem: The current README.md file under the "Installing the bot on a repository" section lacks clarity on where to add the repository name in the constant.js file .

2. Planned Solution:

• Add a new subsection under "Installing the bot on a repository" to explain the following:

  • Location in the code: Reference the checksWhitelist object in constant.js file .
  • How to add the repository name: Provide a clear example of adding a repository name with associated checks and events.

• Ensure that the instructions are concise and beginner-friendly, avoiding ambiguity.

3. New Section Content: The "Installing the bot on a repository" section will be updated as follows:

Installing the Bot on a Repository

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:

   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.

Why These Changes Are Necessary

• This update will provide new contributors with a clear understanding of how to configure the bot for their repository.

• It eliminates any potential confusion about the role of the constant.js file and ensures smooth setup for new users.

Next Steps

Hey, @HardikGoyal2003 if this issue is assigned to me, I will:

1.Implement the above changes in the README.md.
2.Submit a pull request for review.

[seanlip]

@Flying-Pegasus This seems fine to me. Thanks for taking a look, I've assigned you -- feel free to submit a PR!

[Flying-Pegasus]

@seanlip @HardikGoyal2003 I have updated the README.md as I stated above and created a PR. Please review and merge it.