diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index 6fcc1e77..48d37a74 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -307,9 +307,9 @@ Issues and tickets brings in conversations, descriptions, and comments from Jira This option gives you the ability to create a report limited only to pull requests containing a "Score Card" or "Score Chart" bot comment from CodeRabbit or other bots. To enable issues and tickets you must include the tag `` in your prompt. -> **IMPORTANT:** This will automatically remove any pull requests from your reports if they do not contain a "Score Card" or "Score Chart" bot comment. Using this option without setting up a flow to create these comments will result in `No new pull request activity in the last XYZ hours` errors. Do not enable this option unless you have asked coderabbit to create a "Score Card" thourhg a comment or implemented the "Score Chart" bot comment flow below. +> **IMPORTANT:** This will automatically remove any pull requests from your reports if they do not contain a "Score Card" or "Score Chart" bot comment. Using this option without setting up a flow to create these comments will result in `No new pull request activity in the last XYZ hours` errors. Do not enable this option unless you have asked CodeRabbit to create a "Score Card" through a comment or implemented the "Score Chart" bot comment flow below. -For example you can ask coderabbit to check several conditions on a pull request and produce a "Score Chart": +For example, you can ask CodeRabbit to check several conditions on a pull request and produce a "Score Chart":

Click to view example User Score Card/Chart Comment:

@@ -461,7 +461,7 @@ You will create a new chart averaging all the values from various pull requests - Only include checks for very specific scenarios, such as a specific check failing or using tabs vs spaces. - Do not use general rules without explaining specifically what they mean. If you add "Insure the pull request follows development best practices" you must define what "development best practices" actually mean or the AI will guess. - Make one point for each specific check and make sure its a True/False condition. -- Instead of manually commenting on pull requests you can use the [Github Actions Bot](https://github.com/marketplace/actions/create-or-update-comment) to automatically comment on pull requests and trigger coderabbit score card/chart comments by including `@coderabbit` in the comment. +- Instead of manually commenting on pull requests, you can use the [GitHub Actions Bot](https://github.com/marketplace/actions/create-or-update-comment) to automatically comment on pull requests and trigger CodeRabbit score card/chart comments by including `@coderabbitai` in the comment. ## Best Practices diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index 00e71f6d..92a33b6d 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -301,11 +301,11 @@ If enabled, then the reviews that CodeRabbit generates include assessments of ho Besides this setting, issue assessment requires at least one of the following: -- You use the built-in issue managemet system of GitHub or GitLab. +- You use the built-in issue management system of GitHub or GitLab. - You have integrated CodeRabbit with an external issue manager. For more information, see [Integrate issue tracking](/integrations/issue-integrations/) -and [Let CodeRabbit read your issue trakcer](https://docs.coderabbit.ai/guides/setup-best-practices#issues). +and [Let CodeRabbit read your issue tracker](https://docs.coderabbit.ai/guides/setup-best-practices#issues). #### Auto Apply Labels @@ -909,7 +909,7 @@ You associate each set of instructions with a file path relative to the root of your repository. Your path specification can use extended glob patterns. The following example defines a set of path instructions for all TypeScript -and JavaScript files in a reposistory's `src` directory: +and JavaScript files in a repository's `src` directory: @@ -1398,7 +1398,7 @@ We recommend leaving this option enabled. A list of branches that CodeRabbit performs automatic code reviews on, other -than the reposiorty's main branch (usually `main` or `master`.) +than the repository's main branch (usually `main` or `master`.) For example, if you add `staging` as a base branch, then CodeRabbit automatically reviews pull requests on both your repository's default branch and its `staging` branch. pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies: