gradio/.github/PULL_REQUEST_TEMPLATE.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

23 lines
1.4 KiB
Markdown
Raw Normal View History

## Description
2022-01-11 00:44:17 +08:00
Please include a concise summary, in clear English, of the changes in this pull request. If it closes an issue, please mention it here.
2022-01-11 00:44:17 +08:00
Closes: #(issue)
2022-01-11 00:44:17 +08:00
## 🎯 PRs Should Target Issues
2022-01-11 00:44:17 +08:00
Before your create a PR, please check to see if there is [an existing issue](https://github.com/gradio-app/gradio/issues) for this change. If not, please create an issue before you create this PR, unless the fix is very small.
Automated Release Notes (#2306) * add changelog file * Check release notes * Fix syntax * Fix path to changelog * Use changelog * Add to changelog * Add comment * Test comment * Use txt file for comment body * Fix for multiline * rendering on website, changes to changelog * Don't use txt file * Fix pr number * merge * Split it up into two * Test fail * Follow example * Fix syntax * Delete quotes * Add syntax * Fix names * Fix syntax * Modify pr template instead and remove backticks * Check word * changelog file fixes * add 3.4 release notes to changelog * add navigation * replace pr tag and @ usernames with links * remove empty/unused sections from rendering * fix format of 3.4 notes * add releases dir and 3.0-2 notes * render from releases dir * remove changelog file * Fix RN check * Fix path * upcoming release title * switch to periods from dashes * add link to changelog in docs * Add script modify files * Modify changelog * change to release history * modify gh actions * Fix syntax * Skip draft releases during reformatting * skip template when rendering * modify upcoming.md to reflect real changes * replace links with pr tag * Add automated release notes as a new feature in upcoming * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * eUpdate website/homepage/src/style.css Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Misc fixes * one file at root * Fix Changelog check * Modify release notes format script * Fix format script + release notes * Add to contributing * Undo change to release notes from testing script * Add pr 2373 to rl * Modify file path * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> Co-authored-by: aliabd <ali.si3luwa@gmail.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co>
2022-10-04 03:36:59 +08:00
Not adhering to this guideline will result in the PR being closed.
Automated Release Notes (#2306) * add changelog file * Check release notes * Fix syntax * Fix path to changelog * Use changelog * Add to changelog * Add comment * Test comment * Use txt file for comment body * Fix for multiline * rendering on website, changes to changelog * Don't use txt file * Fix pr number * merge * Split it up into two * Test fail * Follow example * Fix syntax * Delete quotes * Add syntax * Fix names * Fix syntax * Modify pr template instead and remove backticks * Check word * changelog file fixes * add 3.4 release notes to changelog * add navigation * replace pr tag and @ usernames with links * remove empty/unused sections from rendering * fix format of 3.4 notes * add releases dir and 3.0-2 notes * render from releases dir * remove changelog file * Fix RN check * Fix path * upcoming release title * switch to periods from dashes * add link to changelog in docs * Add script modify files * Modify changelog * change to release history * modify gh actions * Fix syntax * Skip draft releases during reformatting * skip template when rendering * modify upcoming.md to reflect real changes * replace links with pr tag * Add automated release notes as a new feature in upcoming * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * eUpdate website/homepage/src/style.css Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Misc fixes * one file at root * Fix Changelog check * Modify release notes format script * Fix format script + release notes * Add to contributing * Undo change to release notes from testing script * Add pr 2373 to rl * Modify file path * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> Co-authored-by: aliabd <ali.si3luwa@gmail.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co>
2022-10-04 03:36:59 +08:00
## Tests & Changelog
Automated Release Notes (#2306) * add changelog file * Check release notes * Fix syntax * Fix path to changelog * Use changelog * Add to changelog * Add comment * Test comment * Use txt file for comment body * Fix for multiline * rendering on website, changes to changelog * Don't use txt file * Fix pr number * merge * Split it up into two * Test fail * Follow example * Fix syntax * Delete quotes * Add syntax * Fix names * Fix syntax * Modify pr template instead and remove backticks * Check word * changelog file fixes * add 3.4 release notes to changelog * add navigation * replace pr tag and @ usernames with links * remove empty/unused sections from rendering * fix format of 3.4 notes * add releases dir and 3.0-2 notes * render from releases dir * remove changelog file * Fix RN check * Fix path * upcoming release title * switch to periods from dashes * add link to changelog in docs * Add script modify files * Modify changelog * change to release history * modify gh actions * Fix syntax * Skip draft releases during reformatting * skip template when rendering * modify upcoming.md to reflect real changes * replace links with pr tag * Add automated release notes as a new feature in upcoming * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * eUpdate website/homepage/src/style.css Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Misc fixes * one file at root * Fix Changelog check * Modify release notes format script * Fix format script + release notes * Add to contributing * Undo change to release notes from testing script * Add pr 2373 to rl * Modify file path * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> Co-authored-by: aliabd <ali.si3luwa@gmail.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co>
2022-10-04 03:36:59 +08:00
1. PRs will only be merged if tests pass on CI. To run the tests locally, please set up [your Gradio environment locally](https://github.com/gradio-app/gradio/blob/main/CONTRIBUTING.md) and run the tests: `bash scripts/run_all_tests.sh`
Automated Release Notes (#2306) * add changelog file * Check release notes * Fix syntax * Fix path to changelog * Use changelog * Add to changelog * Add comment * Test comment * Use txt file for comment body * Fix for multiline * rendering on website, changes to changelog * Don't use txt file * Fix pr number * merge * Split it up into two * Test fail * Follow example * Fix syntax * Delete quotes * Add syntax * Fix names * Fix syntax * Modify pr template instead and remove backticks * Check word * changelog file fixes * add 3.4 release notes to changelog * add navigation * replace pr tag and @ usernames with links * remove empty/unused sections from rendering * fix format of 3.4 notes * add releases dir and 3.0-2 notes * render from releases dir * remove changelog file * Fix RN check * Fix path * upcoming release title * switch to periods from dashes * add link to changelog in docs * Add script modify files * Modify changelog * change to release history * modify gh actions * Fix syntax * Skip draft releases during reformatting * skip template when rendering * modify upcoming.md to reflect real changes * replace links with pr tag * Add automated release notes as a new feature in upcoming * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * eUpdate website/homepage/src/style.css Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Misc fixes * one file at root * Fix Changelog check * Modify release notes format script * Fix format script + release notes * Add to contributing * Undo change to release notes from testing script * Add pr 2373 to rl * Modify file path * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> Co-authored-by: aliabd <ali.si3luwa@gmail.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co>
2022-10-04 03:36:59 +08:00
1. You may need to run the linters: `bash scripts/format_backend.sh` and `bash scripts/format_frontend.sh`
1. Unless the pull request is labeled with the "no-changelog-update" label by a maintainer of the repo, all pull requests must update the changelog located in `CHANGELOG.md`:
Automated Release Notes (#2306) * add changelog file * Check release notes * Fix syntax * Fix path to changelog * Use changelog * Add to changelog * Add comment * Test comment * Use txt file for comment body * Fix for multiline * rendering on website, changes to changelog * Don't use txt file * Fix pr number * merge * Split it up into two * Test fail * Follow example * Fix syntax * Delete quotes * Add syntax * Fix names * Fix syntax * Modify pr template instead and remove backticks * Check word * changelog file fixes * add 3.4 release notes to changelog * add navigation * replace pr tag and @ usernames with links * remove empty/unused sections from rendering * fix format of 3.4 notes * add releases dir and 3.0-2 notes * render from releases dir * remove changelog file * Fix RN check * Fix path * upcoming release title * switch to periods from dashes * add link to changelog in docs * Add script modify files * Modify changelog * change to release history * modify gh actions * Fix syntax * Skip draft releases during reformatting * skip template when rendering * modify upcoming.md to reflect real changes * replace links with pr tag * Add automated release notes as a new feature in upcoming * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * eUpdate website/homepage/src/style.css Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Misc fixes * one file at root * Fix Changelog check * Modify release notes format script * Fix format script + release notes * Add to contributing * Undo change to release notes from testing script * Add pr 2373 to rl * Modify file path * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> Co-authored-by: aliabd <ali.si3luwa@gmail.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co>
2022-10-04 03:36:59 +08:00
Please add a brief summary of the change to the Upcoming Release section of the `CHANGELOG.md` file and include
Automated Release Notes (#2306) * add changelog file * Check release notes * Fix syntax * Fix path to changelog * Use changelog * Add to changelog * Add comment * Test comment * Use txt file for comment body * Fix for multiline * rendering on website, changes to changelog * Don't use txt file * Fix pr number * merge * Split it up into two * Test fail * Follow example * Fix syntax * Delete quotes * Add syntax * Fix names * Fix syntax * Modify pr template instead and remove backticks * Check word * changelog file fixes * add 3.4 release notes to changelog * add navigation * replace pr tag and @ usernames with links * remove empty/unused sections from rendering * fix format of 3.4 notes * add releases dir and 3.0-2 notes * render from releases dir * remove changelog file * Fix RN check * Fix path * upcoming release title * switch to periods from dashes * add link to changelog in docs * Add script modify files * Modify changelog * change to release history * modify gh actions * Fix syntax * Skip draft releases during reformatting * skip template when rendering * modify upcoming.md to reflect real changes * replace links with pr tag * Add automated release notes as a new feature in upcoming * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * eUpdate website/homepage/src/style.css Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Misc fixes * one file at root * Fix Changelog check * Modify release notes format script * Fix format script + release notes * Add to contributing * Undo change to release notes from testing script * Add pr 2373 to rl * Modify file path * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> Co-authored-by: aliabd <ali.si3luwa@gmail.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co>
2022-10-04 03:36:59 +08:00
a link to the PR (formatted in markdown) and a link to your github profile (if you like). For example, "* Added a cool new feature by `[@myusername](link-to-your-github-profile)` in `[PR 11111](https://github.com/gradio-app/gradio/pull/11111)`".