add GitHub ISSUE_TEMPLATE.md

2 files changed, 52 insertions, 0 deletions

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..3ac2c69
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,35 @@
+# WebTorrent Contributing Guidelines
+
+- Always use WebTorrent for legal downloads.
+- Always search for a related issue before starting a new issue.
+- Always choose a concise, helpful issue name.
+- Always stay on-topic. If you've got a new bug report or feature request, put it in its own issue.
+- Always be polite to other people.
+- Never post private information, such as torrent or tracker names, IP addresses, etc.
+
+Issues that break the rules may be deleted and locked without warning.
+
+## WebTorrent is an OPEN Open Source Project
+
+Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
+
+## Rules
+
+There are a few basic ground-rules for contributors:
+
+1. **No `--force` pushes** or modifying the Git history in any way.
+1. **External API changes and significant modifications** should be subject to a **pull request** to solicit feedback from other contributors.
+1. Pull requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor.
+1. Use a non-`master` branch for ongoing work.
+1. Contributors should attempt to adhere to the prevailing code style.
+1. Run `npm test` locally before submitting your PR to catch easy-to-miss style & testing issues
+
+## Releases
+
+Declaring formal releases remains the prerogative of the project maintainer.
+
+## Changes to this arrangement
+
+This is an experiment and feedback is welcome! This document is subject to pull requests or changes by contributors where you believe you have something valuable to add or change.
+
+*Thanks to [Rod Vagg](https://github.com/rvagg) and the [LevelUP](https://github.com/rvagg/node-levelup) project for coming up with this model of open source contribution.*
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..94a7c7c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,17 @@
+<!--
+This template is for bug reports. If you are NOT reporting a bug, you can delete this starter template.
+
+Note that leaving sections blank will make it difficult for us to troubleshoot and we may have to close the issue.
+-->
+
+**What version of WebTorrent are you using?**
+
+**For WebTorrent in the browser: which browser are you using?**
+
+**For WebTorrent in Node.js: which version of Node.js are you using?**
+
+**What did you do? Please include the actual source code causing the issue.**
+
+**What did you expect to happen?**
+
+**What actually happened? Please include debug logs from WebTorrent, if possible.**