From 437baf9f399ff1bccc8d939cce27aef152558716 Mon Sep 17 00:00:00 2001 From: Ruben Taelman Date: Mon, 18 Nov 2019 10:27:56 +0100 Subject: [PATCH] Add PR template for new libraries --- .github/PULL_REQUEST_TEMPLATE/New_lib.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/New_lib.md diff --git a/.github/PULL_REQUEST_TEMPLATE/New_lib.md b/.github/PULL_REQUEST_TEMPLATE/New_lib.md new file mode 100644 index 0000000..4d74265 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/New_lib.md @@ -0,0 +1,20 @@ +--- +name: "➕ Add library MYLIB" +about: Suggest an entry to the list of libraries + +--- + + + +To improve the usability of RDFJS tools, +we recommend all listed libraries to have the following elements in their documentation (README or linked). +Please select all elements that apply for your library: + +* [ ] General description: High-level description of tool and available features. +* [ ] Installation: How to install and import into project. +* [ ] Usage: Describing the main features with code examples. +* [ ] Configuration: The available config options for this tool, e.g. constructor params. +* [ ] Specification Compliance: Mention the compliance with respect to any (W3C) specification, including RDFJS interfaces. +* [ ] License: The license under which the library is available. + +Feel free to reuse our [README template](https://github.com/rdfjs/lib-template/blob/master/README.md) for this.