summaryrefslogtreecommitdiff
path: root/changelogs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'changelogs/README.md')
-rw-r--r--changelogs/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/changelogs/README.md b/changelogs/README.md
new file mode 100644
index 00000000000..c4113ccb863
--- /dev/null
+++ b/changelogs/README.md
@@ -0,0 +1,10 @@
+# Generating changelog entries
+
+To generate and validate your changelog entries:
+
+1. Run `bin/changelog` to generate.
+1. Run `scripts/lint-changelog-yaml` to validate.
+
+See [development/changelog] documentation for detailed usage.
+
+[development/changelog]: https://docs.gitlab.com/ee/development/changelog.html