Skip to content

Latest commit

 

History

History
28 lines (16 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

28 lines (16 loc) · 2.6 KB
Raw

First of all, thanks for taking the time to contribute! 🎉👍

Changelog

All changes to the codebase that impact users must be documented in the CHANGELOG.md file.

The format to use is Common Changelog, with the following additional specifications:

  1. The unreleased section of Keep a Changelog is preserved with the addition of a tag to specify which type of release should be published and to foster discussions about it inside pull requests. This tag should be one of the names mandated by SemVer, within brackets: [patch], [minor] or [major]. For example: ## Unreleased [minor].
  2. Each listed change must provide an actionable way to adapt the user’s codebase, either directly in the changelog or through instructions or links.
  3. Changes are a single sentence with no punctuation (like all examples given in Common Changelog).
  4. Since each release is produced automatically from a single pull request, the notice is always used to link to the source pull request rather than references, which would always reference the same pull request. References can instead link to relevant specific parts of an RFC, decision record or diff.

Versioning

SemVer

This module follows the semantic versioning v2 standard.

The public API used for determining breaking changes is the exposed Ansible commands, and not the resulting infrastructure. For example, a major upgrade to the installed Node version can be a minor change, but is not a major change: it is expected that running this playbook may manipulate the entire global installs on the server. On the other hand, a change to the playbook name must trigger a major update, even if the result of executing it yields exactly the same infrastructure as before.

List a new contributor in the Open Terms Archive website

We acknowledge the efforts of our contributors by listing them on our website and this is made possible by the use of the All Contributors bot.

All Contributors enables adding a contributor with a comment on an issue or pull request, without writing code. To do this, please use the dedicated issue on this repository.

Please read the following contributing guide.