summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorDirk Lemstra <dirk@git.imagemagick.org>2017-09-02 10:20:33 +0200
committerDirk Lemstra <dirk@git.imagemagick.org>2017-09-02 10:20:47 +0200
commit2a2833a58620b3c8ed897cf01680927a65736243 (patch)
tree0acc985c5299c9490a580fa08b7e11bcbe938437 /.github
parentb9ba5bbd396fb5201ad270164bedd426a29fb6a0 (diff)
downloadImageMagick-2a2833a58620b3c8ed897cf01680927a65736243.tar.gz
Added github templates.
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md26
-rw-r--r--.github/ISSUE_TEMPLATE.md21
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md12
3 files changed, 59 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 000000000..65bb6a8c1
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,26 @@
+# How to contribute to ImageMagick
+
+#### **Did you find a bug?**
+
+- Please ensure the bug was not already reported by searching our [issues](https://github.com/ImageMagick/ImageMagick/issues).
+- If you're unable to find an open issue addressing the problem, please [open a new one](https://github.com/ImageMagick/ImageMagick/issues/new).
+ Be sure to follow follow the instructions in the issue template.
+
+#### **Did you write a patch that fixes a bug?**
+
+- Open a new pull request with the patch and follow the instructions from the pull request template.
+- Before submitting, please ensure that your code matches the existing coding patterns and practise as demonstrated in the repository.
+- Once the pull request has been accepted for the master (IM7) branch please submit another patch for the
+ [ImageMagick-6](https://github.com/ImageMagick/ImageMagick/tree/ImageMagick-6) branch when applicable.
+
+#### **Do you intend to add a new feature?**
+
+- Join the ImageMagick community on the [discourse server](https://www.imagemagick.org/discourse-server/), suggest your change there and start writing code.
+
+#### **Do you want to change something in the `www` folder?**
+
+- Please submit an pull request in our [website repository](https://github.com/ImageMagick/Website) instead.
+
+If you cannot help us by writing code then take a look at the other ways you could [help](https://www.imagemagick.org/script/support.php) the ImageMagick team.
+
+\- The Wizards \ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 000000000..2709d6ed7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,21 @@
+### Prerequisites
+
+- [ ] I have written a descriptive issue title
+- [ ] I have verified that I am using the latest version of ImageMagick
+- [ ] I have searched [open](https://github.com/ImageMagick/ImageMagick/issues) and [closed](https://github.com/ImageMagick/ImageMagick/issues?q=is%3Aissue+is%3Aclosed) issues to ensure it has not already been reported
+
+### Description
+<!-- A description of the bug or feature -->
+
+### Steps to Reproduce
+<!-- List of steps, sample code, failing test or link to a project that reproduces the behavior.
+ Make sure you place a stack trace inside a code (```) block to avoid linking unrelated issues -->
+
+### System Configuration
+<!-- Tell us about the environment where you are experiencing the bug -->
+
+- ImageMagick version:
+- Environment (Operating system, version and so on):
+- Additional information:
+
+<!-- Thanks for reporting the issue to ImageMagick! -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..37f3f2861
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,12 @@
+### Prerequisites
+
+- [ ] I have written a descriptive pull-request title
+- [ ] I have verified that there are no overlapping [pull-requests](https://github.com/ImageMagick/ImageMagick/pulls) open
+- [ ] I have verified that I am following matches the existing coding patterns and practice as demonstrated in the repository.
+
+### Description
+<!-- A description of the changes proposed in the pull-request
+ If you want to change something in the 'www' folder please
+ open an issue here instead: https://github.com/ImageMagick/Website -->
+
+<!-- Thanks for contributing to ImageMagick! -->