Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 1.9 KB
Raw

json4s Contributors' Guide

Issues

  • Questions should be posted to stackoverflow.com
  • Please describe about your issue in detail (version, 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 "master" 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

master (the default branch)
  • The latest stable version
  • This branch must be able to build against Scala 2.12, 2.13 and 3
  • This branch requires Java 8+ for all Scala versions
4.0
  • The version 4.0 series maintenance branch
  • This branch must be able to build against Scala 2.11, 2.12, 2.13 and 3
  • This branch requires Java 8+ for all Scala versions
3.6
  • The version 3.6 series maintenance branch
  • This branch must be able to build against Scala 2.10, 2.11, 2.12, and 2.13
  • This branch requires Java 8+ for all Scala versions
3.5
  • The version 3.5 series maintenance branch
  • This branch must be able to build against Scala 2.10, 2.11 and 2.12
3.4
  • The version 3.4 series maintenance 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 maintenance 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 CI jobs before merging them.

Testing with default settings is required when push changes:

sbt +test