Skip to content

Add PR template for new libraries #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 2, 2019
Merged

Add PR template for new libraries #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/New_lib.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "➕ Add library MYLIB"
about: Suggest an entry to the list of libraries

---

<!--Thanks for your PR! Please fill in the following template and fill in your library name in the PR title.-->

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.