Skip to content

Latest commit

 

History

History
34 lines (29 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

34 lines (29 loc) · 2.91 KB
Raw

Lagom contributor guidelines

Prerequisites

Before making a contribution, it is important to make sure that the change you wish to make and the approach you wish to take will likely be accepted, otherwise you may end up doing a lot of work for nothing. If the change is only small, for example, if it's a documentation change or a simple bugfix, then it's likely to be accepted with no prior discussion. However, new features, or bigger refactorings should first be discussed in the contributors. Additionally, any issues with the community label have been agreed to be a change that will likely be accepted.

Procedure

  1. Make sure you have signed the Lightbend CLA; if not, sign it online.
  2. Ensure that your contribution meets the following guidelines:
    1. Live up to the current code standard:
    2. Regardless of whether the code introduces new features or fixes bugs or regressions, it must have comprehensive tests. This includes when modifying existing code that isn't tested.
    3. The code must be well documented using the Play flavour of markdown with extracted code snippets (see the Play documentation guidelines.) Each API change must have the corresponding documentation change.
    4. Implementation-wise, the following things should be avoided as much as possible:
      • Global state
      • Public mutable state
      • Implicit conversions
      • ThreadLocal
      • Locks
      • Casting
      • Introducing new, heavy external dependencies
    5. The Lagom API design rules are the following:
      • Features are forever, always think about whether a new feature really belongs to the core framework or if it should be implemented as a module
      • Code must conform to standard style guidelines and pass all tests
    6. New files must:
      • Have a Lightbend copyright header in the style of Copyright (C) 2009-2016 Lightbend Inc. <https://www.lightbend.com>.
      • Not use @author tags since it does not encourage Collective Code Ownership.
  3. Ensure that your commits are squashed. See the Play working with git guide for more information.
  4. Submit a pull request.

If the pull request does not meet the above requirements then the code should not be merged into master, or even reviewed - regardless of how good or important it is. No exceptions.