-
Notifications
You must be signed in to change notification settings - Fork 2
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
[pull] master from draft-js-plugins:master #149
base: master
Are you sure you want to change the base?
Conversation
PR Description updated to latest commit (dad6aa8) |
PR Review
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the review usage page for a comprehensive guide on using this tool. |
PR Code Suggestions
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the improve usage page for a more comprehensive guide on using this tool. |
* Add support for defining `mentionPrefix` as a callback function that takes the `mentionTrigger` as an argument and returns the prefix. * Update multi mention triggers sample to showcase mention prefixes for each trigger. 'topics' data now maps to '#' trigger as it looks better as a prefix than '('. * Add changelog for 5.2.3 * Update `mentionPrefix` param description in docs. * update version --------- Co-authored-by: Aman <[email protected]> Co-authored-by: Dominic Buetow <[email protected]>
Bumps [actions/cache](https://github.com/actions/cache) from 3 to 4. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@v3...v4) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
User description
See Commits and Changes for more details.
Created by pull[bot]
Can you help keep this open source service alive? 💖 Please sponsor : )
Type
enhancement, dependencies
Description
@babel/core
,@babel/preset-react
,prettier
,style-loader
, andwebpack
in the main package.json.tlds
in both the anchor and linkify packages.punycode
in the counter package.whatwg-fetch
in the docs package.Changes walkthrough
package.json
Bump various development dependencies in main package
package.json
@babel/core
from 7.23.0 to 7.23.9.@babel/preset-react
from 7.22.15 to 7.23.3.prettier
from 3.0.3 to 3.2.5.style-loader
from 3.3.3 to 3.3.4.webpack
from 5.88.2 to 5.90.1.package.json
Bump `tlds` dependency in anchor package
packages/anchor/package.json
tlds
from 1.242.0 to 1.250.0.package.json
Bump `punycode` dependency in counter package
packages/counter/package.json
punycode
from 2.3.0 to 2.3.1.package.json
Bump `whatwg-fetch` dependency in docs package
packages/docs/package.json
whatwg-fetch
from 3.6.19 to 3.6.20.package.json
Bump `tlds` dependency in linkify package
packages/linkify/package.json
tlds
from 1.242.0 to 1.250.0.✨ Usage guide:
Overview:
The
describe
tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.When commenting, to edit configurations related to the describe tool (
pr_description
section), use the following template:With a configuration file, use the following template:
Enabling\disabling automation
meaning the
describe
tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.the tool will replace every marker of the form
pr_agent:marker_name
in the PR description with the relevant content, wheremarker_name
is one of the following:type
: the PR type.summary
: the PR summary.walkthrough
: the PR walkthrough.Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
Custom labels
The default labels of the
describe
tool are quite generic: [Bug fix
,Tests
,Enhancement
,Documentation
,Other
].If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
Examples for custom labels:
Main topic:performance
- pr_agent:The main topic of this PR is performanceNew endpoint
- pr_agent:A new endpoint was added in this PRSQL query
- pr_agent:A new SQL query was added in this PRDockerfile changes
- pr_agent:The PR contains changes in the DockerfileThe list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
Inline File Walkthrough 💎
For enhanced user experience, the
describe
tool can add file summaries directly to the "Files changed" tab in the PR page.This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs).
To enable inline file summary, set
pr_description.inline_file_summary
in the configuration file, possible values are:'table'
: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.true
: A collapsable file comment with changes title and a changes summary for each file in the PR.false
(default): File changes walkthrough will be added only to the "Conversation" tab.Utilizing extra instructions
The
describe
tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.
Examples for extra instructions:
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
More PR-Agent commands
See the describe usage page for a comprehensive guide on using this tool.