Update PR template to be simpler and more approachable #6679
Conversation
Can we not instead enforce that contributors do update it? Perhaps by conditioning CI checks on its completion, new PR guidelines in the Contributions wiki, or something else? Whether the changes are a bug fix, refactor, breaking API changes, features, or user-visible seem like core details maintainers (and our users via release notes) would like to know at a glance. And since we're an OSS project, it may be all the more imperative that we document what kind of changes were made, why, and the deliberations that went into it. This info is and will be consumed by the community for years to come and serves as a historical record of non-trivial value. If descriptions are omitted when the PR template includes relevant suggestions, why would contributors include it when not prompted? imo this revision might conversely lead to even fewer descriptions. Not strictly relevant to this PR, but it would also be nice if we could enforce stylistic guidelines for PR titles and/or commit messages (perhaps they include a prefix ( |
|
@snehankekre Take a look and let me know what you think. One positive side effect is that the changes can generate release notes! I think it might be nice to get that set up (though we will need to get better at PR titles). |
|
@kmcgrady whoa, automated GH release notes are the way to go! LGTM 😄 We'll also have to consistently use the new labels in future PRs. |
|
Yep @snehankekre ! The GHA change will enforce these. I haven't played with the release notes, but I think they depend on the PR title. We will need to have more diligence in PR titles for the release notes. Or they can be more...technical and then you can draw from them the better wording for a changelog. |
* develop: Remove tensorflow and pytorch from test requirements (streamlit#6807) Fix readme links (streamlit#6800) Update PR template to be simpler and more approachable (streamlit#6679) README updated with links to docs (streamlit#6780) Refactor: withHostCommunication -> HostCommunicationManager (streamlit#6746) Add python 3.11 to classifiers list. (streamlit#6786) Release/1.23.1 (streamlit#6777) We depend on typing-extensions 4.0.1 (streamlit#6776) Release/1.23.0 (streamlit#6773) Fix typo in data_editor docstring and deprecation msg: `edited_rows` -> `edited_cells` (streamlit#6770) Fix: Remove flaky date input calendar snapshot test (streamlit#6769) Fix 3218, patch pydantic in_ipython function (streamlit#6664) Upgrade react-range to fix memory usage of sliders (streamlit#6764) Make st.write pretty-print dataclasses using st.help (streamlit#6750) Replace curly with straightquotes in docstring examples (streamlit#6757)
* Update PR Template * Modify some wording * Add generated release notes and label requirements * Change user-facing to users * Make separate jobs so they run in parallel
* Update PR Template * Modify some wording * Add generated release notes and label requirements * Change user-facing to users * Make separate jobs so they run in parallel
* Update PR Template * Modify some wording * Add generated release notes and label requirements * Change user-facing to users * Make separate jobs so they run in parallel
Describe your changes
Many contributors are not updating the PR Description, and we feel the template is too long and complicated. We aimed to simplify it to get the core details and encourage better information coming out.
Testing Plan
There's no need to test since this PR does not touch any code. We can verify the markdown is valid by copying and pasting the contents into a GitHub Markdown and verify the Preview works as expected.
Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.