Skip to content

Commit 653782d

Browse files
Update pull request template
1 parent c7a68ac commit 653782d

1 file changed

Lines changed: 15 additions & 7 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,25 @@ Please explain the changes you made here.
44

55
**Checklist**
66

7-
- [ ] Code compiles correctly and linting passes locally
8-
- [ ] For all _code_ changes, an entry added to the `CHANGELOG.md` file describing and linking to
9-
this PR
7+
- [ ] The PR title follows the
8+
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) syntax, leading
9+
with `fix:`, `feat:`, `chore:`, `ci:`, etc.
10+
- [ ] Code compiles correctly and linting (via trunk) passes locally
1011
- [ ] Tests added for new functionality, or regression tests for bug fixes added as applicable
11-
- [ ] For public APIs, new features, etc., PR on [docs repo](https://github.com/dgraph-io/docs)
12-
staged and linked here
12+
- [ ] For public APIs, new features, etc., a PR on the
13+
[docs repo](https://github.com/dgraph-io/dgraph-docs) staged and linked here. This process can
14+
be simplified by going to the [public docs site](https://docs.dgraph.io/) and clicking the
15+
"Edit this page" button at the bottom of page(s) relevant to your changes. Ensure that you
16+
indicate in the PR that this is an **unreleased** feature so that it does not get merged into
17+
the main docs prematurely.
1318

1419
**Instructions**
1520

16-
- The PR title should follow the [Conventional Commits](https://www.conventionalcommits.org/)
17-
syntax, leading with `fix:`, `feat:`, `chore:`, `ci:`, etc.
21+
- The PR title should follow the
22+
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) syntax, leading
23+
with `fix:`, `feat:`, `chore:`, `ci:`, etc. Ensure any breaking changes are appropriately marked
24+
with a `!`. For instance, `feat(dql)!: Remove the foobar func` would indicate that this is a
25+
breaking change to the DQL syntax.
1826
- The description should briefly explain what the PR is about. In the case of a bugfix, describe or
1927
link to the bug.
2028
- In the checklist section, check the boxes in that are applicable, using `[x]` syntax.

0 commit comments

Comments
 (0)