From: jonathan vanasco <jonathan@2xlp.com>
Date: Mon, 6 Apr 2020 18:59:45 +0000 (-0400)
Subject: adding example readme
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ff294507b664e9c414944a7509a0f71338957fbf;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

adding example readme
---

diff --git a/doc/build/changelog/unreleased_XX/README.txt b/doc/build/changelog/unreleased_XX/README.txt
new file mode 100644
index 0000000000..037a23509d
--- /dev/null
+++ b/doc/build/changelog/unreleased_XX/README.txt
@@ -0,0 +1,30 @@
+Individual per-changelog files go here in `.rst` format, which are pulled in by
+changelog (https://github.com/sqlalchemyorg/changelog; version 0.4.0 or higher) 
+to be rendered into the `changelog_xx.rst` file.
+
+At release time, the files in `unreleased_xx/`` are removed and written directly
+into the changelog.
+
+Rationale is so that multiple changes being merged into gerrit don't produce
+conflicts.   Note that gerrit does not support custom merge handlers unlike
+git itself.
+
+Each changelog file should be named `{ID}.rst`, wherein `ID` is the unique
+identifier of the issue in the issue tracker
+
+In the example below, the `tags` and `tickets` contain a comma-separated listing
+because there are more than one element.
+
+================================================================================
+								Example Below
+================================================================================
+
+
+.. change::
+    :tags: sql, orm
+    :tickets: 1, 2, 3
+
+    Please use reStructuredText and Sphinx markup when possible.  For example
+    method :meth:`.Index.create` and parameter :paramref:`.Index.create.checkfirst`, 
+    and :class:`.Table` which will subject to the relevant markup.  Also please
+    note the indentions required for the text.