From 2be1b80297b8873eef5c537a682f3a4c2fb51077 Mon Sep 17 00:00:00 2001
From: Anton Tananaev <anton.tananaev@gmail.com>
Date: Mon, 21 Aug 2017 05:43:44 +1200
Subject: Add github documentation

---
 .github/CONTRIBUTING.md   | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 93 insertions(+)
 create mode 100644 .github/CONTRIBUTING.md
 create mode 100644 .github/ISSUE_TEMPLATE.md

(limited to '.github')

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 000000000..f6f8b3137
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,47 @@
+# Contributing to Traccar
+
+Please make sure you read this guide before commenting on any issue or creating a new issue or pull request.
+
+Before asking anything, please search for an answer in:
+
+- [Traccar documentation](https://www.traccar.org/documentation/)
+- [Traccar forums](https://www.traccar.org/forums/)
+- Relevant repositories (see below)
+- [Google Search](https://www.google.com/)
+
+GitHub issues should be used ONLY for feature requests and bug reports. For general discussions please use [Traccar forums](https://www.traccar.org/forums/).
+
+There are multiple Traccar projects. If you create a new issue you MUST do it in the relevant repository:
+
+- [Traccar Server](https://github.com/tananaev/traccar)
+- [Traccar Web Interface](https://github.com/tananaev/traccar-web)
+- [Traccar Client for Android](https://github.com/tananaev/traccar-client-android)
+- [Traccar Client for iOS](https://github.com/tananaev/traccar-client-ios)
+- [Traccar Manager for Android](https://github.com/tananaev/traccar-manager-android)
+- [Traccar Manager for iOS](https://github.com/tananaev/traccar-manager-ios)
+
+If you are not sure where your issue belongs to, please use Traccar Server main repository.
+
+If you want to discuss something that applies to both Android and iOS apps, please use Android repository.
+
+## Bug Reports
+
+Before creating a bug report make sure that you have tested latest official release with default configuration.
+
+Only create a bug report issue if you are confident that there is a problem in Traccar software.
+
+Provide as much details as possible, including log fragments, operating system and hardware information.
+
+## Feature Requests
+
+Before creating a feature request make sure that the feature or modification that you are requesting is not yet implemented.
+
+Search reposiroty to ensure that there is no existing issues for your request. If there is, add a new comment on that issue.
+
+Provide as much details as possible, including use case for your feature and any benefits that you can think of.
+
+## Pull Requests
+
+If you want to contribute some code to Traccar, it is recommended to discuss your solution with maintainers before starting any work.
+
+Any code that you want to contribute must be of high quality and follow existing code patterns and styles.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 000000000..1e42752ed
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,46 @@
+<!--
+
+Do you want to ask a question? Traccar official forum is the best place for getting support: https://www.traccar.org/forums/
+
+This is a template for bug reports. For feature requests and code discussions please remove everything that is not relevant.
+
+-->
+
+### Prerequisites
+
+Put an X between the brackets for completed steps:
+
+* [ ] I have read contribution guide.
+* [ ] I have searched in documentation, GitHub and forums.
+* [ ] I have tried official release and configuration.
+* [ ] I have provided all information below.
+
+### Description
+
+[Description of the issue]
+
+### Steps to Reproduce
+
+1. [First Step]
+2. [Second Step]
+3. [and so on...]
+
+**Expected behavior:** [What you expect to happen]
+
+**Actual behavior:** [What actually happens]
+
+### Versions
+
+**Project version:** [Relevant project version]
+
+**Operating system:** [Operating system details]
+
+**Hardware:** [Relevant hardware information]
+
+### Logs
+
+[Relevant logs fragments in text format. Please use appropriate markdown syntax.]
+
+### Additional Information
+
+[Any additional information, configuration or data that might be necessary to reproduce the issue.]
-- 
cgit v1.2.3