Merge pull request #122 from xAPI-vle/templates

Issue/PR Templates

.github/CONTRIBUTING.md

+### Issue Templates
+If you are reporting an issue, you need to replace the parts of the template where you see `{{some text}}`.
+
+### Code Structure
+Repository = Data layer = Reads and writes data from a location (variable/DB/external API/etc).
+
+Service = Business layer = Operates on data and transforms data from a given structure to a required structure.

.github/ISSUE_TEMPLATE.md

+**Description**
+- {{Brief description of your bug}}
+
+**Version**
+- {{branch}} at {{commit}} on {{version - found in your copy of the VERSION file}} 
+
+**Steps to reproduce the bug**
+1. {{steps}}
+
+**Expected behaviour**
+- {{feature}} should be {{expectedResult}} because {{reason}}.
+
+**Actual behaviour**
+- {{feature}} is {{actualResult}}.
+
+**Server information**
+- {{database}} with {{authentication}}.
+
+**Client information**
+- OS: {{operatingSystem}}
+- Browser: {{browser}} {{version}}
+
+**Additional information**
+- {{additionalInfo}})

.github/PULL_REQUEST_TEMPLATE.md

+**Description**
+- {{Brief description of your PR}}
+
+**Related Issues**
+- #{{issue_number}}
+
+**PR Type**
+- Fix or Enhancement

contributing.md

-### Issue Templates
-If you are reporting an issue, please click the links below and your issue will be prefilled with our template. You need to replace the parts of the template where you see `{{some text}}`.
-
-- [Bug](../../issues/new?title={{Brief description of your bug}}&body=**Version**%0A{{branch}} at {{commit}} on {{version - found in your copy of the VERSION file}} %0A%0A**Steps to reproduce the bug**%0A{{steps}}%0A%0A**Expected behaviour**%0A{{feature}} should be {{expectedResult}} because {{reason}}.%0A%0A**Actual behaviour**%0A{{feature}} is {{actualResult}}.%0A%0A**Server information**%0A{{database}} with {{authentication}}.%0A%0A**Client information**%0AOS: {{operatingSystem}}%0ABrowser: {{browser}} version 1.0.1%0A%0A**Additional information**%0A{{additionalInfo}}): reports an feature that is not working as expected.
-- [Enhancement](../../issues/new?title={{Brief description of your enhancement}}&body=**Motive**%0A{{why the enhancement is needed}}%0A%0A**Result**%0A{{what the enhancement is}}%0A%0A**Additional information**%0A{{additionalInfo}}): requests a removal, addition, or change of a feature.
-- [Question](../../issues/new?title={{Brief description of your question}}&body={{question}}%3F): asks how a feature should be used or what the feature does.
-
-### Code Structure
-Repository = Data layer = Reads and writes data from a location (variable/DB/external API/etc).
-Service = Business layer = Operates on data and transforms data from a given structure to a required structure.

docs/readme.md

-# [Moodle Logstore xAPI](https://moodle.org/plugins/view/logstore_xapi)
-> Emits events from the [Moodle](https://moodle.org/) Logstore as [xAPI](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI.md) statements.
-
-[![Build Status](https://travis-ci.org/jlowe64/moodle-logstore_xapi.svg?branch=master)](https://travis-ci.org/jlowe64/moodle-logstore_xapi)
-[![Moodle Plugin Directory](http://img.shields.io/badge/moodle-plugin-orange.svg)](https://moodle.org/plugins/view/logstore_xapi)
-[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/LearningLocker/learninglocker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
-- [Installation](installation.md)
-- [Report bugs, enhancements, and questions](../contributing.md#issue-templates)
-- [Supported events](events.md)
-- [Developer documentation](developers.md)
-- [Plugin design](design.md)