Skip to content

Commit 00dd02b

Browse files
continue[bot]sestinjContinueUsername
authored
docs: add note about using keywords for linking PRs to issues (#8316)
Added a new section in the Contributing guide explaining how to use GitHub keywords (closes, fixes, resolves) to automatically link PRs to issues. This helps contributors properly reference issues in their PRs. Closes #7794 Generated with [Continue](https://continue.dev) Co-authored-by: Continue Agent <[email protected]> Co-authored-by: Continue <[email protected]> Co-authored-by: Username <[email protected]>
1 parent 646b76e commit 00dd02b

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/CONTRIBUTING.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,35 @@ const example = "Hello, Continue!";
298298

299299
</Tip>
300300

301+
### Linking Your PR to Issues
302+
303+
<Info>
304+
305+
**Important**: When your PR addresses a specific issue, make sure to link it using GitHub keywords.
306+
307+
</Info>
308+
309+
To automatically link your PR to an issue and close it when the PR is merged, use one of these keywords in your PR description:
310+
311+
- `closes #issue_number`
312+
- `fixes #issue_number`
313+
- `resolves #issue_number`
314+
315+
**Example PR description:**
316+
```markdown
317+
Improved the installation guide with clearer steps for Windows users.
318+
319+
Closes #1234
320+
```
321+
322+
This helps us track which issues are being worked on and automatically closes them when your PR is merged.
323+
324+
<Tip>
325+
326+
Learn more about linking PRs to issues in the [GitHub documentation](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests).
327+
328+
</Tip>
329+
301330
## 💡 Tips for Success
302331

303332
- **Use the Continue agent**: It knows our documentation standards and will save you time

0 commit comments

Comments
 (0)