add docs about serializers
[storage-units.git] / CONTRIBUTING.asciidoc
blob6e64c71b4ee09f81069543ba1fc733930232a328
1 = Making a contribution
3 Just send me a pull request or open up a ticket & we will take it from there together.
5 == Labels
7 Labels are divided into categories by colons (":"). In case you want to know what each of them means, read the following:
9 === Bug
11 The *Bug* category is used for anything that breaks something for a user.
13 * Bug: Blocker - used for tickets that must be resolved before the next release
14 * Bug: High - used for tickets that should be resolved before the next release
15 * Bug: Low - used for tickets that might be resolved before the next release
17 === Component
19 The *Component* category is used to classify which part or component of the system is affected.
21 * Component: API - used for tickets that affect the API
22 * Component: Build - used for tickets that affect the build setup
23 * Component: Documentation - used for tickets that affect the documentation
24 * Component: Implementation - used for tickets that affect the implementation
25 * Component: Shared - used for tickets that affect the share code module
26 * Component: Test - used for tickets that affect the tests
27 * Component: Units - used for tickets that affect the units themselves
29 === Serialization
31 The *Serialization* category is used to classify which serialization mechanism is affected.
33 * Serialization: EclipseLink - used for tickets that are related to EclipseLink
34 * Serialization: Jackson - used for tickets that are related to Jackson
35 * Serialization: MongoDB - used for tickets that are related to MongoDB
36 * Serialization: xStream - used for tickets that are related to xStream
38 === Uncategorized
40 This final category contains any other label.
42 * question - used for tickets that deal with user questions rather than code changes
43 * bouny - used for tickets that have a bounty on them