CONTRIBUTING.asciidoc

   1 = Making a contribution
   2
   3 Just send me a pull request or open up a ticket & we will take it from there together.
   4
   5 == Labels
   6
   7 Labels are divided into categories by colons (":"). In case you want to know what each of them means, read the following:
   8
   9 === Bug
  10
  11 The *Bug* category is used for anything that breaks something for a user.
  12
  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
  16
  17 === Cache
  18
  19 The *Cache* category is used to classify which cache implementation is used.
  20
  21 * Cache: Caffeine - used for tickets that are related to the Caffeine implementation
  22 * Cache: ConcurrentMap - used for tickets that are related to the ConcurrentMap implementation
  23 * Cache: Guava - used for tickets that are related to the Guava implementation
  24 * Cache: JCache - used for tickets that are related to the JCache implementation
  25
  26 === Component
  27
  28 The *Component* category is used to classify which part or component of the system is affected.
  29
  30 * Component: API - used for tickets that affect the API
  31 * Component: Build - used for tickets that affect the build setup
  32 * Component: Documentation - used for tickets that affect the documentation
  33 * Component: Implementation - used for tickets that affect the implementation
  34 * Component: Shared - used for tickets that affect the share code module
  35 * Component: Test - used for tickets that affect the tests
  36
  37 === Integration
  38
  39 The *Integration* category is used for a potential future addition that will provide something like `@Memoize` in order to memoize the call to a method.
  40
  41 * Integration: CDI - used for tickets that talk about integrating with CDI
  42 * Integration: Guice - used for tickets that talk about integrating with Guice
  43 * Integration: Spring - used for tickets that talk about integrating with Spring
  44
  45 === Resolved
  46
  47 The *Resolved* category is used to capture how a ticket was resolved.
  48
  49 * Resolved: Closed - all necessary changes were performed, delivery will be part of the next release
  50 * Resolved: Duplicate - changes were performed as part of another ticket, or will be in the future.
  51 * Resolved: Invalid - ticket description contains nothing actionable
  52 * Resolved: Wontfix - ticket description contains actionable change, but project owners won't perform the change (themselves)
  53
  54 === Uncategorized
  55
  56 This final category contains any other label.
  57
  58 * question - used for tickets that deal with user questions rather than code changes