From 0ecfddfeb2a6e9d95842aff21020eb6e78add501 Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Fri, 18 Mar 2016 23:00:43 +0900 Subject: [PATCH 1/6] using new github features: issue template, contributing, pullreq template --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++ ISSUE_TEMPLATE.md | 45 +++++++++++++++++++++++++++++++++++++++ PULL_REQUIEST_TEMPLATE.md | 9 ++++++++ 3 files changed, 84 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 ISSUE_TEMPLATE.md create mode 100644 PULL_REQUIEST_TEMPLATE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..569ef5eb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ + +## TO ADD A PROJECT TO QUICKLISP + +For background info, see [Getting a library into +Quicklisp](http://blog.quicklisp.org/2015/01/getting-library-into-quicklisp.html) +and [Some problems when adding libraries to +Quicklisp](http://blog.quicklisp.org/2015/01/some-problems-when-adding-libraries-to.html). + +Please do *not* open a pull request. + +Please open a github issue here: + + https://github.com/quicklisp/quicklisp-projects/issues + +In the issue, please provide a brief description of what your project +is for and where to fetch its sources. + +Your project should include some form of README describing the project +and its purpose. + +The system definition(s) for the project should include :DESCRIPTION, +:AUTHOR, and :LICENSE options. + + +Personal pet peeve: Please don't describe your project simply by +saying it's an interface to some C library. Explain what the C library +is for and why someone might want to use it from Common Lisp, and link +to any useful information about the C library. + +Quicklisp on Twitter : @quicklisp (https://twitter.com/quicklisp) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..fed352eb --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,45 @@ + +# Please add <>. + +<> + +Checklists: + ++ [ ] The license of the code is clear and allows for its redistribution. ++ [ ] My library works on more than just one implementation of Common Lisp. CCL and SBCL in x86-64, at least. + + [ ] My library builds without warnings. ++ [ ] My library does not conflict with existing system. + + [ ] System name. + + [ ] Package name / nickname. + + [ ] Does not modify the global readtable destructively. ++ [ ] My ASDF system has sufficient system definition metadata. + + [ ] :license + + [ ] :author + + [ ] :description ++ [ ] My library has a sufficient README describing its purpose. ++ [ ] My library does not depend on libraries outside Quicklisp. ++ [ ] My library does not depend on quicklisp itself. ++ [ ] There is a library with the similar feature, but the motivation in + this library is clear (see below, not a requirement) ++ [ ] My library has an usage instruction. (not a requirement) ++ [ ] I am an author of the library. (not a requirement) + +[Getting a library into Quicklisp](http://blog.quicklisp.org/2015/01/getting-library-into-quicklisp.html) +[Some problems when adding libraries to Quicklisp](http://blog.quicklisp.org/2015/01/some-problems-when-adding-libraries-to.html). + +<> + +## Author guideline (remove when you create an issue) + ++ Please don't describe your project simply by saying it's an interface to + some C library. Explain what the C library is for and why someone might + want to use it from Common Lisp, and link to any useful information about + the C library. ++ If there is a library with the similar feature, please consider + collaboration/coordination, rather than making an individual library. + If this is unachievable, please describe what is different from/superior + to those libraries. It could be speed, simpler implementation, + compatibility to other libraries, extensibility, and not necessarily a + new feature. See + [Dealing with "redundant" libraries](http://blog.quicklisp.org/2015/04/dealing-with-redundant-libraries.html) + diff --git a/PULL_REQUIEST_TEMPLATE.md b/PULL_REQUIEST_TEMPLATE.md new file mode 100644 index 00000000..2ccce80c --- /dev/null +++ b/PULL_REQUIEST_TEMPLATE.md @@ -0,0 +1,9 @@ + + +As noted, *please do not open a pull request* for adding libraries to quicklisp. + +Please open a github issue here: + + https://github.com/quicklisp/quicklisp-projects/issues + + From 2756931b896169273dd631cc5ed6427fce72b74a Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Fri, 18 Mar 2016 23:03:19 +0900 Subject: [PATCH 2/6] fix --- ISSUE_TEMPLATE.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index fed352eb..70c4f0bd 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,7 +1,7 @@ -# Please add <>. +# Please add . -<> + Checklists: @@ -24,10 +24,7 @@ Checklists: + [ ] My library has an usage instruction. (not a requirement) + [ ] I am an author of the library. (not a requirement) -[Getting a library into Quicklisp](http://blog.quicklisp.org/2015/01/getting-library-into-quicklisp.html) -[Some problems when adding libraries to Quicklisp](http://blog.quicklisp.org/2015/01/some-problems-when-adding-libraries-to.html). - -<> + ## Author guideline (remove when you create an issue) @@ -43,3 +40,8 @@ Checklists: new feature. See [Dealing with "redundant" libraries](http://blog.quicklisp.org/2015/04/dealing-with-redundant-libraries.html) +See also: + ++ [Getting a library into Quicklisp](http://blog.quicklisp.org/2015/01/getting-library-into-quicklisp.html) ++ [Some problems when adding libraries to Quicklisp](http://blog.quicklisp.org/2015/01/some-problems-when-adding-libraries-to.html). + From dde8b6db48012ee4e0603fd98509b649aae05fff Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Fri, 18 Mar 2016 23:06:12 +0900 Subject: [PATCH 3/6] macroexpand-hook --- ISSUE_TEMPLATE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 70c4f0bd..984ea2e6 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -12,6 +12,7 @@ Checklists: + [ ] System name. + [ ] Package name / nickname. + [ ] Does not modify the global readtable destructively. + + [ ] Does not alter macroexpand-hook destructively. + [ ] My ASDF system has sufficient system definition metadata. + [ ] :license + [ ] :author From 8cb73fc99f99d65c3065a7fd280ffd698ce826af Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Fri, 18 Mar 2016 23:11:08 +0900 Subject: [PATCH 4/6] redundant library --- ISSUE_TEMPLATE.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 984ea2e6..d23544c5 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -20,8 +20,9 @@ Checklists: + [ ] My library has a sufficient README describing its purpose. + [ ] My library does not depend on libraries outside Quicklisp. + [ ] My library does not depend on quicklisp itself. -+ [ ] There is a library with the similar feature, but the motivation in - this library is clear (see below, not a requirement) ++ [ ] There is no library with the similar feature. Or, although there is a + similar library, I have a clear motivation to make it a standalone + library, and it is described in README (see below, not a requirement) + [ ] My library has an usage instruction. (not a requirement) + [ ] I am an author of the library. (not a requirement) @@ -34,7 +35,7 @@ Checklists: want to use it from Common Lisp, and link to any useful information about the C library. + If there is a library with the similar feature, please consider - collaboration/coordination, rather than making an individual library. + collaboration/coordination, rather than writing an individual library. If this is unachievable, please describe what is different from/superior to those libraries. It could be speed, simpler implementation, compatibility to other libraries, extensibility, and not necessarily a From edaa164e479961e3df17f1166f6e30518d0fb23b Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Fri, 18 Mar 2016 23:17:26 +0900 Subject: [PATCH 5/6] non-lisp dependencies --- ISSUE_TEMPLATE.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index d23544c5..9452640a 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -18,8 +18,12 @@ Checklists: + [ ] :author + [ ] :description + [ ] My library has a sufficient README describing its purpose. -+ [ ] My library does not depend on libraries outside Quicklisp. ++ [ ] My library does not depend on Common Lisp libraries outside Quicklisp. + [ ] My library does not depend on quicklisp itself. ++ [ ] My library does not depend on non-lisp libraries outside Quicklisp, + or they are easily installable by standard package managers (such as + apt-get, yum). In particular, it is available on Debian8. (not a requirement) + + [ ] The installation command below is comprehensive. (optional) + [ ] There is no library with the similar feature. Or, although there is a similar library, I have a clear motivation to make it a standalone library, and it is described in README (see below, not a requirement) @@ -28,6 +32,12 @@ Checklists: +Commands for installing Non-lisp dependencies: + +```sh +apt-get install +``` + ## Author guideline (remove when you create an issue) + Please don't describe your project simply by saying it's an interface to From 3f7fe0f5407cfdfe8d9704d1f95a4d61ca8735af Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Fri, 18 Mar 2016 23:26:43 +0900 Subject: [PATCH 6/6] typo in filename --- PULL_REQUIEST_TEMPLATE.md => PULL_REQUEST_TEMPLATE.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename PULL_REQUIEST_TEMPLATE.md => PULL_REQUEST_TEMPLATE.md (100%) diff --git a/PULL_REQUIEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md similarity index 100% rename from PULL_REQUIEST_TEMPLATE.md rename to PULL_REQUEST_TEMPLATE.md