From: Bob Halley <halley@dnspython.org>
Date: Fri, 9 Feb 2024 22:12:59 +0000 (-0800)
Subject: github contributing and pull request template
X-Git-Tag: v2.6.0rc1~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ed9795fa9b39c4a12f5a1a9e0eeea4240d1efb07;p=thirdparty%2Fdnspython.git

github contributing and pull request template

(cherry picked from commit 7401efab4d6c2db93886ca92b4479ce90d749a51)
---

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..e68d359c
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,3 @@
+# Description
+
+Please describe your PR here.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..55c10be5
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+# Contributing to dnspython
+
+## Reporting Issues
+
+Please start with a clear and concise description of what the bug is, and what you
+expected to happen instead.  Next, please describe in detail how to reproduce the bug.
+Making the replication steps as simple and short as possible is very helpful.  Please
+also include the requested version information.
+
+## Contributing Code
+
+For any significant change or new API, we recommend opening a Feature Request issue
+and having a discussion before coding begins.
+
+Please add tests for any code, as PRs without testing or which reduce the overall code
+test coverage may not be merged.  Code should also be formatted with "black", be typed
+(and pass type checking), and also pass the test suite.
+
+Our thanks for being a contributor!