From 106fc36c81b028bdab490a4393466cd51eb4bf11 Mon Sep 17 00:00:00 2001
From: Ika <ikatyang@gmail.com>
Date: Mon, 21 Jan 2019 08:33:07 +0800
Subject: [PATCH] docs: add CHANGELOG.unreleased.md (#5775)

Ref: https://github.com/prettier/prettier/issues/5735#issuecomment-452784056
---
 .github/PULL_REQUEST_TEMPLATE.md |  1 +
 CHANGELOG.unreleased.md          | 43 ++++++++++++++++++++++++++++++++
 2 files changed, 44 insertions(+)
 create mode 100644 CHANGELOG.unreleased.md

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index e57f6a4e7..af5a54cb2 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,6 +5,7 @@
 
 - [ ] I’ve added tests to confirm my change works.
 - [ ] (If changing the API or CLI) I’ve documented the changes I’ve made (in the `docs/` directory)
+- [ ] (If not an internal change) I’ve added my changes to the `CHANGELOG.unreleased.md` file following the template.
 - [ ] I’ve read the [contributing guidelines](https://github.com/prettier/prettier/blob/master/CONTRIBUTING.md).
 
 **✨[Try the playground for this PR](https://prettier.io/playground-redirect)✨**
diff --git a/CHANGELOG.unreleased.md b/CHANGELOG.unreleased.md
new file mode 100644
index 000000000..7b5a8f5be
--- /dev/null
+++ b/CHANGELOG.unreleased.md
@@ -0,0 +1,43 @@
+<!--
+
+Format:
+
+- Category: Title ([#PR] by [@user])
+
+  Description
+
+  ```
+  // Input
+  Code Sample
+
+  // Output (Prettier stable)
+  Code Sample
+
+  // Output (Prettier master)
+  Code Sample
+  ```
+
+Details:
+
+  Description: optional if the `Title` is enough to explain everything.
+
+Examples:
+
+- TypeScript: Correctly handle `//` in TSX ([#5728] by [@JamesHenry])
+
+  Previously, putting `//` as a child of a JSX element in TypeScript led to an error
+  because it was interpreted as a comment. Prettier master fixes this issue.
+
+  <!-- prettier-ignore --\>
+  ```js
+  // Input
+  const link = <a href="example.com">http://example.com</a>
+
+  // Output (Prettier stable)
+  // Error: Comment location overlaps with node location
+
+  // Output (Prettier master)
+  const link = <a href="example.com">http://example.com</a>;
+  ```
+
+-->