aboutsummaryrefslogtreecommitdiff
path: root/.github/CONTRIBUTING.md
blob: f6f8b31377511ce9e7aba2e8535e4cbaeadd193a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
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.