|
1 |
| -<!-- 💡 To write a useful PR description, make sure that your description covers: |
2 |
| -- WHAT this PR is changing: |
3 |
| - - How was it PREVIOUSLY. |
4 |
| - - How it will be from NOW on. |
5 |
| -- WHY this PR is needed. |
6 |
| -- CONTEXT, i.e. to which initiative, project or RFC it belongs. |
7 |
| -
|
8 |
| -The structure of the description doesn't matter as much as covering these points, so use |
9 |
| -your best judgement based on your context. |
10 |
| -Learn how to write good pull request description: https://www.notion.so/sourcegraph/Write-a-good-pull-request-description-610a7fd3e613496eb76f450db5a49b6e?pvs=4 --> |
11 |
| - |
| 1 | +<!-- PR description tips: https://www.notion.so/sourcegraph/Write-a-good-pull-request-description-610a7fd3e613496eb76f450db5a49b6e --> |
12 | 2 |
|
13 | 3 | ## Test plan
|
14 | 4 |
|
15 |
| -<!-- All pull requests REQUIRE a test plan: https://docs-legacy.sourcegraph.com/dev/background-information/testing_principles --> |
16 |
| - |
17 |
| - |
18 |
| -## Changelog |
19 |
| - |
20 |
| -<!-- |
21 |
| -1. Ensure your pull request title is formatted as: $type($domain): $what |
22 |
| -2. Add bullet list items for each additional detail you want to cover (see example below) |
23 |
| -3. You can edit this after the pull request was merged, as long as release shipping it hasn't been promoted to the public. |
24 |
| -4. For more information, please see this how-to https://www.notion.so/sourcegraph/Writing-a-changelog-entry-dd997f411d524caabf0d8d38a24a878c? |
25 |
| -
|
26 |
| -Audience: TS/CSE > Customers > Teammates (in that order). |
27 |
| -
|
28 |
| -Cheat sheet: $type = chore|fix|feat $domain: source|search|ci|release|plg|cody|local|... |
29 |
| ---> |
30 |
| - |
31 |
| -<!-- |
32 |
| -Example: |
33 |
| -
|
34 |
| -Title: fix(search): parse quotes with the appropriate context |
35 |
| -Changelog section: |
| 5 | +<!-- REQUIRED; info at https://docs-legacy.sourcegraph.com/dev/background-information/testing_principles --> |
36 | 6 |
|
37 | 7 | ## Changelog
|
38 | 8 |
|
39 |
| -- When a quote is used with regexp pattern type, then ... |
40 |
| -- Refactored underlying code. |
41 |
| ---> |
| 9 | +<!-- OPTIONAL; info at https://www.notion.so/sourcegraph/Writing-a-changelog-entry-dd997f411d524caabf0d8d38a24a878c --> |
0 commit comments