emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/compat f342b01a10 12/16: Update manual


From: ELPA Syncer
Subject: [elpa] externals/compat f342b01a10 12/16: Update manual
Date: Wed, 4 Jan 2023 07:57:27 -0500 (EST)

branch: externals/compat
commit f342b01a100c90701325926c5a29e85434c47323
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>

    Update manual
---
 README.md       | 13 +++++--------
 compat-tests.el | 10 +++-------
 compat.texi     | 15 ++++++---------
 3 files changed, 14 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 51b18aa0de..e52d6d4694 100644
--- a/README.md
+++ b/README.md
@@ -42,15 +42,12 @@ Bug and patches
 
 Patches, bug reports and comments can be sent via [GitHub].  These may
 include issues in the compatibility code, missing definitions or
-performance issues.  If you do not have a GitHub account, we also
-provide a [development mailing list] and a [issue tracker] on
-SourceHut, the latter also being accessible via [email].
+performance issues.  We also provide a [development mailing list] and
+a [issue tracker] on SourceHut, the latter also being accessible via
+[email].
 
-When contributing, make sure to provide test and use the existing
-tests defined in compat-test.el.  These can be easily executed using
-the bundled Makefile:
-
-    make test
+When contributing, you are required to provide tests. We use continuous
+integration to check if patches preserve existing functionality.
 
 [development mailing list]:
     https://lists.sr.ht/~pkal/compat-devel
diff --git a/compat-tests.el b/compat-tests.el
index ad648bacf7..729e6c55e4 100644
--- a/compat-tests.el
+++ b/compat-tests.el
@@ -19,13 +19,9 @@
 
 ;; Tests for compatibility functions from compat.el.
 ;;
-;; Note that not all functions have tests (yet), for the most part
-;; because it is difficult to create a reproducible environment to
-;; test these in or their tests are trivial -- or a combination of
-;; both.
-;;
-;; Tests are welcome, but until then anyone working on these functions
-;; should take care to test these manually.
+;; Note that not all functions have tests yet. Additions are very welcome. The
+;; tests are written in a simple, explicit style. If you intend to use a
+;; function, which doesn't have tests yet, please add them here.
 
 ;;; Code:
 
diff --git a/compat.texi b/compat.texi
index 2836cbb856..e01ec421e5 100644
--- a/compat.texi
+++ b/compat.texi
@@ -3006,19 +3006,16 @@ The function @code{pp-emacs-lisp-code}.
 @node Development
 @chapter Development
 
-Compat is developed on @uref{https://sr.ht/~pkal/compat, SourceHut}. A
-restricted @uref{https://github.com/phikal/compat.el, GitHub mirror} is
-also maintained.
+Compat is developed on GitHub and mirrored to SourceHut.
 
 Patches and comments can be sent to the
-@uref{https://lists.sr.ht/~pkal/compat-devel, development mailing list}
-(@email{~pkal/compat-devel@@lists.sr.ht,
+@uref{https://lists.sr.ht/~pkal/compat-devel, development mailing
+list} (@email{~pkal/compat-devel@@lists.sr.ht,
 ~pkal/compat-devel@@lists.sr.ht}).  Bug reports are best sent to the
 @uref{https://todo.sr.ht/~pkal/compat, issue tracker}
-(@email{~pkal/compat@@todo.sr.ht, ~pkal/compat@@todo.sr.ht}).  The
-GitHub mirror can also be used to submit patches.  These may include
-issues in the compatibility code, missing definitions or performance
-issues.
+(@email{~pkal/compat@@todo.sr.ht, ~pkal/compat@@todo.sr.ht}).  GitHub
+can also be used to submit patches.  These may include issues in the
+compatibility code, missing definitions or performance issues.
 
 Please note that as a GNU ELPA package, Compat requires contributors to
 have signed the



reply via email to

[Prev in Thread] Current Thread [Next in Thread]