diff README.rst @ 6189:16f59121f8f6 mercurial-4.8

test-compat: merge mercurial-4.9 into mercurial-4.8

--- a/README.rst	Fri Nov 19 09:59:57 2021 +0300
+++ b/README.rst	Wed Feb 23 00:09:39 2022 +0300
@@ -76,6 +76,17 @@
     [extensions]
     evolve = ~/evolve/hgext3rd/evolve
 
+Pitfalls
+--------
+
+If you get ``"failed to import extension evolve: No module named 'evolve'"``
+error, there are a couple of things to check:
+
+* make sure you gave pip the correct package name (it's hg-evolve),
+
+* make sure evolve is installed for the same version of Python that you use for
+  running Mercurial (``hg debuginstall | grep Python``).
+
 Server-only Setup
 =================
 
@@ -117,7 +128,7 @@
 How to Contribute
 =================
 
-Discussion happens on the #hg-evolve IRC on libera_.
+Discussion happens in #hg-evolve and #mercurial on libera_ IRC network.
 
 .. _libera: https://libera.chat/
 
@@ -199,31 +210,31 @@
 Release Checklist
 =================
 
+* use contrib/merge-test-compat.sh to merge with the test compatibility
+  branches,
+
 * make sure the tests are happy on all supported versions,
 
-  You can use the `contrib/merge-test-compat.sh` to merge with the test
-  compatibility branches.
+* make sure there is no code difference between the compatibility branches and
+  stable (no diff within hgext3rd/),
 
-* make sure there is no code difference between the compat branches and stable
-  (no diff within `hgext3rd/`),
-
-* update the `testedwith` variable for all extensions (remove '.dev'):
+* update the ``testedwith`` variable for all extensions (remove '.dev'):
 
   - hgext3rd/evolve/metadata.py
   - hgext3rd/topic/__init__.py
   - hgext3rd/pullbundle.py
 
-* make sure the changelog is up to date,
+* make sure CHANGELOG is up-to-date,
 
-* add a date to the changelog entry for the target version,
+* add a date to the CHANGELOG entry for the target version,
 
-* update the `__version__` field of all relevant extensions:
+* update the ``__version__`` field of all relevant extensions:
 
   - hgext3rd/evolve/metadata.py
   - hgext3rd/topic/__init__.py
   - hgext3rd/pullbundle.py (if touched)
 
-* create a new Debian entry:
+* create a new Debian changelog entry:
 
   - debchange --newversion x.y.z-1 "new upstream release"
   - debchange --release
@@ -235,21 +246,25 @@
 
 * tag the commit,
 
+* move ``@`` bookmark to the new tag,
+
 * push and publish the tag,
 
 * upload the tarball to PyPI,
 
-* make an announcement on [e-mail] (possibly on
-  [e-mail] too),
+* make an announcement on [e-mail] and
+  [e-mail],
 
-* bump versions of all extensions and add '.dev' (see existing commits as an
+* bump versions of all extensions and add ``.dev`` (see existing commits as an
   example):
 
   - hgext3rd/evolve/metadata.py
   - hgext3rd/topic/__init__.py
   - hgext3rd/pullbundle.py
 
-  The version we use on the stable branch during development should be
-  `x.y.z+1.dev`. The version of the default branch should be `x.y+1.0.dev`.
+  Version bump rules:
+
+  - stable branch x.y.z+1.dev
+  - default branch x.y+1.0.dev
 
 * merge stable into default.