From 9ceeaf213ba3ca46a71f7fdb48dfd7608c8fbc40 Mon Sep 17 00:00:00 2001 From: Mickael Remond Date: Sat, 12 Mar 2016 17:54:23 +0100 Subject: [PATCH] Provide guidance for issue reporting and pull requests on Github --- .github/ISSUE_TEMPLATE | 16 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE | 23 +++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE create mode 100644 .github/PULL_REQUEST_TEMPLATE diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE new file mode 100644 index 000000000..8d1a5f259 --- /dev/null +++ b/.github/ISSUE_TEMPLATE @@ -0,0 +1,16 @@ +Please answer these questions before submitting your issue. It may help ! + +Thanks! + +1. What version of ejabberd are you using ? + + +2. What operating system are you using ? + + +3. How did you install ejabberd (source, package, distribution) ? + + +4. What did not work as expected ? What that error in the log ? + What that unexpected behaviour ? What was the expected result ? + diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 000000000..554cad4b6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,23 @@ +We are open to contribution for ejabberd, as Github pull requests (PR). +Here is a few points to consider before submitting your pull request. +(You can remove the whole text after reading). + +1. Does this PR address an issue ? + Please reference it in PR description. + +2. Have you properly described the proposed changed ? + +3. Please, make sure the change is atomic and does only touch the + needed modules. + If you have other changes / fixes to provide, please make them as + separate PR. + +4. If you change or new feature involves backends, + did you make sure you change is compliant with all backends or + provide the feature for all backends ? + +5. Do you provides tests ? + How can we check the behaviour of the code ? + +6. Did you consider documentation changes on project + processone/docs.ejabberd.im ?