Skip to content

Latest commit

 

History

History
48 lines (41 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

48 lines (41 loc) · 1.84 KB
Raw

Contribute to Irmin

License

Irmin is distributed under the ISC license. Every OCaml source file should start with a header comment instantiating the following template (use appropriate comment syntax for other languages):

(*
 * Copyright (c) [year(s)] [Holder <email>]
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *)

Note that:

  • The holder, on the copyright line, is the name of individual contributors and/or their company;
  • When adding a significant new contribution to a file (i.e. more like whole new features, rather than simple fixes), check whether there already is a copyright for your copyright holder (see above):
    • If there is one, mentioning any year, it is not required to add the current year (but this is allowed). In no case should you replace the existing year with the current one.
    • If there is no line for your copyright holder, you should add one, with the current year.

For example, for a source file with multiple contributors spanning several years, the copyright lines may look as follows:

(*
 * Copyright (c) 2013-2022 Thomas Gazagnaire <thomas@gazagnaire.org>
 * Copyright (c) 2018-2022 Tarides <contact@tarides.com>
 *