diff --git a/templates/contribute/commit.md b/templates/contribute/commit.md index dc6e87d185..040d0ad7f9 100644 --- a/templates/contribute/commit.md +++ b/templates/contribute/commit.md @@ -4,18 +4,19 @@ We are using the following convention for writing pull request titles and descri ## Format -Note: "Title:" and "Description:" do not actually appear - +The title of the PR will be the title of the commit after the PR is merged. It should have the following format: ```markdown - Title: (): +``` - Description: +The description of the PR, before the `---`, will be the description of the commit after the PR is merged. It should have the following format: +```markdown