Skip to content

docs: add note about using keywords for linking PRs to issues #8316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 18, 2025
Merged

docs: add note about using keywords for linking PRs to issues #8316

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/CONTRIBUTING.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,35 @@ const example = "Hello, Continue!";

</Tip>

### Linking Your PR to Issues

<Info>

**Important**: When your PR addresses a specific issue, make sure to link it using GitHub keywords.

</Info>

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:

- `closes #issue_number`
- `fixes #issue_number`
- `resolves #issue_number`

**Example PR description:**
```markdown
Improved the installation guide with clearer steps for Windows users.

Closes #1234
```

This helps us track which issues are being worked on and automatically closes them when your PR is merged.

<Tip>

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).

</Tip>

## 💡 Tips for Success

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