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

Update the readme me file. Fixed #336 #339

Closed
wants to merge 3 commits into from

Conversation

Flying-Pegasus
Copy link
Contributor

@Flying-Pegasus Flying-Pegasus commented Dec 9, 2024

Provided a clear description of where to add the repo name in the constant.js file.

Explanation

Updated the 'Installing the Bot on a Repository' section,
Added the bulletpoints to show step by step process.

The new lines I have added :
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.

The more clear explaination is provided in the comments of issue #336 which was approved by the maintainer.

Checklist

  • I have successfully deployed my own instance of Oppiabot.
    • You can find instructions for doing this here.
  • I have manually tested all the changes made in this PR following the manual tests matrix.

Fixed #336

Provided a clear description of where to add the repo name in the constant.js file.
Copy link
Member

@seanlip seanlip left a comment

Choose a reason for hiding this comment

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

@Flying-Pegasus This codebase has no file called constant.js. Could you please double-check that your instructions work as written?

corrected constant.js to constants.js
Copy link
Contributor Author

@Flying-Pegasus Flying-Pegasus left a comment

Choose a reason for hiding this comment

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

@seanlip Changed constant.js to constants.js from the previous commit. Please review it.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@seanlip
Copy link
Member

seanlip commented Dec 10, 2024

@Flying-Pegasus Please follow the guidance at https://github.com/oppia/oppia/wiki/Rules-for-making-PRs#step-4-create-a-pull-request for naming your PRs.

Solved the changes raised by the maintainer
@Flying-Pegasus Flying-Pegasus deleted the patch-1 branch December 10, 2024 11:47
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.

Update the readme me file
2 participants