aboutsummaryrefslogtreecommitdiff
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAnton Tananaev <anton.tananaev@gmail.com>2017-08-21 05:43:44 +1200
committerAnton Tananaev <anton.tananaev@gmail.com>2017-08-21 05:43:44 +1200
commit2be1b80297b8873eef5c537a682f3a4c2fb51077 (patch)
tree18ea461bac5acc8ebf4a620417cd0f30e06b018c /.github/CONTRIBUTING.md
parentbaf9c062836987e5316341279c3063a63983725f (diff)
downloadtrackermap-server-2be1b80297b8873eef5c537a682f3a4c2fb51077.tar.gz
trackermap-server-2be1b80297b8873eef5c537a682f3a4c2fb51077.tar.bz2
trackermap-server-2be1b80297b8873eef5c537a682f3a4c2fb51077.zip
Add github documentation
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md47
1 files changed, 47 insertions, 0 deletions
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.