Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.61 KB

json4s Contributers' Guide

Issues

  • Questions should be posted to stackoverflow.com
  • Please describe about your issue in detail (verison, situation, examples)
  • We may close your issue when we have no plan to take action right now. We appreciate your understanding.

Pull Requests

  • Pull requests basically should be sent toward "3.6" branch
  • Source/binary compatibility always must be kept as far as possible
  • Prefer creating scala source code for each class/object/trait (of course, except for sealed trait)
  • json4s build checks binary compatibility by using MiMa for maintenance releases (e.g. 3.3.x).

Branches

3.6 (the default branch)
  • The latest stable version
  • This branch must be able to build against Scala 2.10, 2.11 and 2.12
  • This branch requires Java 8+ for all Scala versions
3.5
  • The version 3.5 series maintainance branch
  • This branch must be able to build against Scala 2.10, 2.11 and 2.12
3.4
  • The version 3.4 series maintainance branch
  • All the backports must be source/binary compatibility
  • This branch must be able to build against Scala 2.10 and 2.11
3.3
  • The version 3.3 series maintainance branch
  • All the backports must be source/binary compatibility
  • This branch must be able to build against Scala 2.10 and 2.11

Testing your pull request

All the pull requests must pass the Travis CI jobs before merging them.

https://travis-ci.org/json4s/json4s

Testing with default settings is required when push changes:

sbt test