CONTRIBUTING.md 1.82 KB
Newer Older
1
2
# Contributing

3
If you have a usage question for a product built on Mapbox GL (such as our iOS or Android SDKs), please visit https://www.mapbox.com/help/.
4

5
If you want to contribute code:
6

7
1. Please familiarize yourself with the [install process](INSTALL.md).
8

9
1. Ensure that existing [pull requests](https://github.com/mapbox/mapbox-gl-native/pulls) and [issues](https://github.com/mapbox/mapbox-gl-native/issues) don’t already cover your contribution or question.
10

11
1. Pull requests are gladly accepted. If there are any changes that developers using one of the GL SDKs should be aware of, please update the **master** section of the relevant changelog(s):
12
  * [Mapbox Maps SDK for Android](platform/android/CHANGELOG.md)
13
14
  * [Mapbox Maps SDK for iOS](platform/ios/CHANGELOG.md)
  * [Mapbox Maps SDK for macOS](platform/macos/CHANGELOG.md)
Minh Nguyễn's avatar
Minh Nguyễn committed
15
  * [node-mapbox-gl-native](platform/node/CHANGELOG.md)
16

17
1. Prefix your commit messages with the platform(s) your changes affect: `[core]`, `[android]`, `[ios]`, `[macos]`, `[node]`, or `[qt]`.
Jason Wray's avatar
Jason Wray committed
18

19
20
Please note the special instructions for contributing new source code files, asset files, or user-facing strings to the [iOS SDK](platform/ios/DEVELOPING.md#contributing) or [macOS SDK](platform/macos/DEVELOPING.md#contributing).

21
### Github issue labels
Jesse Bounds's avatar
Jesse Bounds committed
22

23
Our labeling system is:
Jesse Bounds's avatar
Jesse Bounds committed
24

25
26
27
 * **minimalistic:** Labels’ usefulness are inversely proportional to how many we have.
 * **objective:** Labels should be objective enough that any two people would agree on a labeling decision.
 * **useful:** Labels should track state or capture semantic meaning that would otherwise be hard to search for.
Jesse Bounds's avatar
Jesse Bounds committed
28

29
We’ve color-coded our labels by facet to make them easier to use:
Jesse Bounds's avatar
Jesse Bounds committed
30

31
32
33
34
35
36
 * type (blue)
 * platform (black)
 * actionable status (red)
 * non-actionable status (grey)
 * importance / urgency (green)
 * topic / project / misc (yellow)