mirrors/zed
1
0
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2024-10-23 14:59:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
zed/.github/pull_request_template.md

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

16 lines
216 B
Markdown
Raw Normal View History

Link to pull requests in changelog notes (#15996) This PR changes how we ask users to draft up PRs and how release note generation happens. We no longer force the user to create the markdown URL link, but we do ask them to use the `closes` [GitHub magic word](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to link the PR to an issue, so that the issue is closed automatically when closing the PR. As for the changelog release notes, we are no longer linking to the issues, but the PR itself, which should contain the issue if a reader wants to dive further back. This makes our output more consistent, as every line will have a link, even if there is no issue associated, and it removes the need for us to try to parse the issue url in the body to try to correct mistakes in how they were forming Markdown urls - the PR url is always returned in the request, which makes it easy. **Lastly, it's just a lot less annoying to make the release notes.** The new PR format will be: ``` Closes #ISSUE Release Notes: - Added/Fixed/Improved ... ``` The new script output format will be: ``` PR Title: theme: Use a non-transparent color for the fallback `title_bar.inactive_background` Credit: ([#15709](https://github.com/zed-industries/zed/pull/15709); thanks [maxdeviant](https://github.com/maxdeviant)) Release Notes: - linux: Changed the fallback color of `title_bar.inactive_background` to a non-transparent value. -------------------------------------------------------------------------------- PR Title: Skip over folded regions when iterating over multibuffer chunks Credit: ([#15646](https://github.com/zed-industries/zed/pull/15646); thanks [osiewicz](https://github.com/osiewicz)) Release Notes: - Fixed poor performance when editing in the assistant panel after inserting large files using slash commands -------------------------------------------------------------------------------- ``` This still requires us to manually apply the credit line, but the line is already fully formed, so this should still be faster than having to manually create that line / fix any line where someone messed it up (which was all the time). I would just automatically apply it to the release notes, but sometimes we have multiple bullet points in a single PR and no real structure is enforced, so I foresee doing anything automatic breaking and needing manual adjustment. Release Notes: - N/A
2024-08-08 19:26:17 +00:00
Closes #ISSUE
Create pull_request_template.md
2023-05-12 17:14:54 +00:00
Release Notes:
Link to pull requests in changelog notes (#15996) This PR changes how we ask users to draft up PRs and how release note generation happens. We no longer force the user to create the markdown URL link, but we do ask them to use the `closes` [GitHub magic word](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to link the PR to an issue, so that the issue is closed automatically when closing the PR. As for the changelog release notes, we are no longer linking to the issues, but the PR itself, which should contain the issue if a reader wants to dive further back. This makes our output more consistent, as every line will have a link, even if there is no issue associated, and it removes the need for us to try to parse the issue url in the body to try to correct mistakes in how they were forming Markdown urls - the PR url is always returned in the request, which makes it easy. **Lastly, it's just a lot less annoying to make the release notes.** The new PR format will be: ``` Closes #ISSUE Release Notes: - Added/Fixed/Improved ... ``` The new script output format will be: ``` PR Title: theme: Use a non-transparent color for the fallback `title_bar.inactive_background` Credit: ([#15709](https://github.com/zed-industries/zed/pull/15709); thanks [maxdeviant](https://github.com/maxdeviant)) Release Notes: - linux: Changed the fallback color of `title_bar.inactive_background` to a non-transparent value. -------------------------------------------------------------------------------- PR Title: Skip over folded regions when iterating over multibuffer chunks Credit: ([#15646](https://github.com/zed-industries/zed/pull/15646); thanks [osiewicz](https://github.com/osiewicz)) Release Notes: - Fixed poor performance when editing in the assistant panel after inserting large files using slash commands -------------------------------------------------------------------------------- ``` This still requires us to manually apply the credit line, but the line is already fully formed, so this should still be faster than having to manually create that line / fix any line where someone messed it up (which was all the time). I would just automatically apply it to the release notes, but sometimes we have multiple bullet points in a single PR and no real structure is enforced, so I foresee doing anything automatic breaking and needing manual adjustment. Release Notes: - N/A
2024-08-08 19:26:17 +00:00
- Added/Fixed/Improved ...
Tweak pull request template to (hopefully) make it clearer (#7287) I keep seeing people leave the wrapping parentheses, like `(Added)` in their release notes. This PR tries making it clearer that we only want *one* of "Added", "Fixed", or "Improved". Release Notes: - N/A
2024-02-02 16:41:47 +00:00
Move note about screenshots up in the PR template (#8501) This PR rearranges the PR template to move the line about including screenshots or media up underneath the `Added/Fixed/Improved` section. This makes it easier to delete one section or the other depending on what kind of change you're making. Release Notes: - N/A
2024-02-27 19:19:18 +00:00
Optionally, include screenshots / media showcasing your addition that can be included in the release notes.
Update pull_request_template.md Make it easier to edit to select the N/A option.
2024-05-07 14:51:38 +00:00
### Or...
Link to pull requests in changelog notes (#15996) This PR changes how we ask users to draft up PRs and how release note generation happens. We no longer force the user to create the markdown URL link, but we do ask them to use the `closes` [GitHub magic word](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to link the PR to an issue, so that the issue is closed automatically when closing the PR. As for the changelog release notes, we are no longer linking to the issues, but the PR itself, which should contain the issue if a reader wants to dive further back. This makes our output more consistent, as every line will have a link, even if there is no issue associated, and it removes the need for us to try to parse the issue url in the body to try to correct mistakes in how they were forming Markdown urls - the PR url is always returned in the request, which makes it easy. **Lastly, it's just a lot less annoying to make the release notes.** The new PR format will be: ``` Closes #ISSUE Release Notes: - Added/Fixed/Improved ... ``` The new script output format will be: ``` PR Title: theme: Use a non-transparent color for the fallback `title_bar.inactive_background` Credit: ([#15709](https://github.com/zed-industries/zed/pull/15709); thanks [maxdeviant](https://github.com/maxdeviant)) Release Notes: - linux: Changed the fallback color of `title_bar.inactive_background` to a non-transparent value. -------------------------------------------------------------------------------- PR Title: Skip over folded regions when iterating over multibuffer chunks Credit: ([#15646](https://github.com/zed-industries/zed/pull/15646); thanks [osiewicz](https://github.com/osiewicz)) Release Notes: - Fixed poor performance when editing in the assistant panel after inserting large files using slash commands -------------------------------------------------------------------------------- ``` This still requires us to manually apply the credit line, but the line is already fully formed, so this should still be faster than having to manually create that line / fix any line where someone messed it up (which was all the time). I would just automatically apply it to the release notes, but sometimes we have multiple bullet points in a single PR and no real structure is enforced, so I foresee doing anything automatic breaking and needing manual adjustment. Release Notes: - N/A
2024-08-08 19:26:17 +00:00
Closes #ISSUE
Update pull_request_template.md Make it easier to edit to select the N/A option.
2024-05-07 14:51:38 +00:00
Release Notes:
Tweak pull request template to (hopefully) make it clearer (#7287) I keep seeing people leave the wrapping parentheses, like `(Added)` in their release notes. This PR tries making it clearer that we only want *one* of "Added", "Fixed", or "Improved". Release Notes: - N/A
2024-02-02 16:41:47 +00:00
- N/A
Reference in a new issue Copy permalink