aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-03-02 10:16:02 -0800
committerGarrett D'Amore <garrett@damore.org>2018-03-02 10:16:02 -0800
commit05aba898cedc8c2c1d9f1a21f6963e450b3f127c (patch)
treed6cc34b19da6342477103155d64af6e93faf922e /.github
parent7f2b2f174a796132b61e2d0cf7aed94f69e24d88 (diff)
downloadnng-05aba898cedc8c2c1d9f1a21f6963e450b3f127c.tar.gz
nng-05aba898cedc8c2c1d9f1a21f6963e450b3f127c.tar.bz2
nng-05aba898cedc8c2c1d9f1a21f6963e450b3f127c.zip
Move some docs to docs directory, add CONTRIBUTING and templates.
Diffstat (limited to '.github')
-rw-r--r--.github/issue_template.md18
-rw-r--r--.github/pull_request_template.md7
2 files changed, 25 insertions, 0 deletions
diff --git a/.github/issue_template.md b/.github/issue_template.md
new file mode 100644
index 00000000..76ad855a
--- /dev/null
+++ b/.github/issue_template.md
@@ -0,0 +1,18 @@
+
+Note that by filing an issue, you agree that you have read and agreed to
+our contribution guidelines.
+
+## NNG & Platform details.
+
+<include NNG version, and platform/operating system, and if you are using
+another programming language what language>
+
+## Expected Behavior
+
+## Actual Behavior
+
+## Steps to Reproduce
+
+<If possible, if include a copy of, or link to, a minimal test program
+to demonstrate the behavior. We prefer test cases written in C when
+possible.>
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..5ae7c257
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,7 @@
+fixes #<issue number> <issue synopsis>
+
+<Comments describing your change. Not all changes need this.>
+
+Note that the above format should be used in your git commit comments.
+You agree that by submitting a PR, you have read and agreed to our
+contributing guidelines.