gradio/.github/PULL_REQUEST_TEMPLATE.md
Freddy Boulton fb7d768013
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-03 12:36:59 -07:00

1.5 KiB

Description

Please include:

  • relevant motivation
  • a summary of the change
  • which issue is fixed.
  • any additional dependencies that are required for this change.

Closes: # (issue)

Checklist:

  • I have performed a self-review of my own code
  • I have added a short summary of my change to the CHANGELOG.md
  • My code follows the style guidelines of this project
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

A note about the CHANGELOG

Hello 👋 and thank you for contributing to Gradio!

All pull requests must update the change log located in CHANGELOG.md, unless the pull request is labeled with the "no-changelog-update" label.

Please add a brief summary of the change to the Upcoming Release > Full Changelog section of the CHANGELOG.md file and include 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)".

If you would like to elaborate on your change further, feel free to include a longer explanation in the other sections. If you would like an image/gif/video showcasing your feature, it may be best to edit the CHANGELOG file using the GitHub web UI since that lets you upload files directly via drag-and-drop.