From 1b1f86981839f27cf85bca738e530fff646ed349 Mon Sep 17 00:00:00 2001
From: Jonathan Wilkes <jon.w.wilkes@gmail.com>
Date: Sun, 18 Mar 2018 20:08:01 -0400
Subject: [PATCH] clean up contributor guidelines, add rule about external
library dependencies
---
README.md | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index fcc7666ed..69b92aac8 100644
--- a/README.md
+++ b/README.md
@@ -287,11 +287,16 @@ A few guidelines:
and libraries must be stable, consistent, well-documented, and easy to use.
* Develop incrementally. Small, solid improvements to the software are
preferable to large, disruptive ones.
-* Make sure you aren't duplicating existing functionality, especially core
- functionality. For backwards compatibility Purr Data ships many legacy
+* Try not to duplicate existing functionality.
+ For backwards compatibility Purr Data ships many legacy
libraries which unfortunately duplicate the same functionality. This makes
it harder to learn how to use Pd, and makes it burdensome to read patches
and keep track of all the disparate implementations.
+* Keep dependencies to a minimum. Cross-platform dependency handling is
+ unfortunately still an open research problem. In the even that you need
+ an external library dependency, please mirror it at git.purrdata.net
+ so that the build system doesn't depend on the availability of external
+ infrastructure.
Here are some of the current tasks:
@@ -313,6 +318,8 @@ Here are some of the current tasks:
* status: some externals have their own testing environments, but they are
limited as they require manual intervention to run and read the
results inside a graphical window.
+ We currently have a crude test system that at least ensures that each
+ external library instantiates without crashing.
Here's an email thread with Katja Vetter's design, which looks to
be automatable:
http://markmail.org/message/t7yitfc55anus76i#query:+page:1+mid:chb56ve7kea2qumn+state:results
--
GitLab