branch: externals/compat
commit 109e9edf9984f5e0523cfbaa2e2b392f544833bd
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Update readme
---
README.md | 39 ++++++++++++++++++---------------------
compat.texi | 12 ++++++++----
2 files changed, 26 insertions(+), 25 deletions(-)
diff --git a/README.md b/README.md
index 09e2259d04..7523adb2b9 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,5 @@
COMPATibility Library for Emacs
===============================
-
Find here the source for compat.el, a forwards-compatibility library
for (GNU) Emacs Lisp, versions 24.4 and newer.
@@ -13,46 +12,44 @@ version].
[snapshot version]:
https://elpa.gnu.org/devel/doc/compat.html
-Contribute
-----------
-
-As compat.el is distribed as part of [GNU ELPA], and therefore
-requires a [copyright assignment] to the [FSF], for all non-trivial code
-contributions.
-
-[GNU ELPA]:
- http://elpa.gnu.org/packages/compat.html
-[copyright assignment]:
-
https://www.gnu.org/software/emacs/manual/html_node/emacs/Copyright-Assignment.html
-[FSF]:
- https://www.fsf.org/
Source code
-----------
-
-Compat is developed on [GitHub]. The code is mirrored to the [GNU ELPA
repository].
+Compat is developed on [GitHub]. The code is mirrored to the [GNU ELPA
+repository].
[GitHub]:
https://github.com/emacs-compat/compat
[GNU ELPA repository]:
https://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/?h=externals/compat
+
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. We also provide a [development mailing list].
-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
+
+Contribute
+----------
+As compat.el is distribed as part of [GNU ELPA], and therefore
+requires a [copyright assignment] to the [FSF], for all non-trivial code
+contributions.
+
+[GNU ELPA]:
+ http://elpa.gnu.org/packages/compat.html
+[copyright assignment]:
+
https://www.gnu.org/software/emacs/manual/html_node/emacs/Copyright-Assignment.html
+[FSF]:
+ https://www.fsf.org/
+
+
Distribution
------------
-
compat.el and all other source files in this directory are distributed
under the [GNU Public License], Version 3 (like Emacs itself). The manual
(`compat.texi`) is distributed under the [GNU Free Documentation
diff --git a/compat.texi b/compat.texi
index 1ddcbfc4d2..4a92e6a9c0 100644
--- a/compat.texi
+++ b/compat.texi
@@ -2871,11 +2871,15 @@ definitions or performance issues. We also provide a
list} (@email{~pkal/compat-devel@@lists.sr.ht,
~pkal/compat-devel@@lists.sr.ht}).
-Please note that as a GNU ELPA package, Compat requires contributors to
-have signed the
+Please note that as a GNU ELPA package, Compat requires contributors
+to have signed the
@uref{https://www.gnu.org/software/emacs/manual/html_node/emacs/Copyright-Assignment.html,
-FSF copyright assignment}, before any non-trivial contribution (roughly
-15 lines of code) can be applied.
+FSF copyright assignment}, before any non-trivial contribution
+(roughly 15 lines of code) can be applied. It is important that you
+provide tests when you contribute new functionality. Compat has 100%
+test coverage by the test suite. We use continuous integration to
+check if patches preserve existing functionality.
+
@node Function Index
@appendix Function Index
