Help users to contribute to the right place, which is often BC

nienienienie · Jan 30, 2018 · 4f1e560 · 4f1e560
1 parent f2ed42a
commit 4f1e560
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/.github/contributing.md b/.github/contributing.md
@@ -0,0 +1,5 @@
+Spongy Castle is a repackage of **Bouncy Castle**, targeted at Android, with no substantial differences to the code (just renaming of packages, etc). The GitHub repository for Bouncy Castle can be found at https://github.com/bcgit/bc-java .
+
+This means that if you think you have a bug in Spongy Castle that's not specific to Android, you first need to check whether the problem can be reproduced in the Bouncy Castle code base. If the problem originates in Bouncy Castle, you'll need to raise an issue with the Bouncy Castle project to get it fixed - once that fix is released, I can make a fresh release of Spongycastle based on that updated version.
+
+
diff --git a/.github/issue_template.md b/.github/issue_template.md
@@ -0,0 +1,7 @@
+<!-- 
+Does this issue relate specifically to the Spongy Castle project? Spongy Castle is a repackage of **Bouncy Castle**, targeted at Android, with no substantial differences to the code (just renaming of packages, etc).
+
+If you're seeing strange behaviour, please verify that the behaviour is _different_ to what the corresponding version of Bouncy Castle does. If there's a problem with Bouncy Castle, please raise an issue at https://github.com/bcgit/bc-java/issues . 
+
+If you have question about how to use Spongy Castle correctly, it's best to raise a question on https://stackoverflow.com/ tagged with [`spongycastle`](https://stackoverflow.com/questions/tagged/spongycastle).
+-->
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,3 @@
+<!-- 
+Check that this change is specific to the Spongy Castle project, and could not be applied to the underlying [Bouncy Castle](https://github.com/bcgit/bc-java) project.
+-->
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,5 @@
		Spongy Castle is a repackage of Bouncy Castle, targeted at Android, with no substantial differences to the code (just renaming of packages, etc). The GitHub repository for Bouncy Castle can be found at https://github.com/bcgit/bc-java .

		This means that if you think you have a bug in Spongy Castle that's not specific to Android, you first need to check whether the problem can be reproduced in the Bouncy Castle code base. If the problem originates in Bouncy Castle, you'll need to raise an issue with the Bouncy Castle project to get it fixed - once that fix is released, I can make a fresh release of Spongycastle based on that updated version.