Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (43 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

69 lines (43 loc) · 2.2 KB

Contribute to the Assisted Installer Project

Pull Request Template

Every PR should fill in the PULL_REQUEST_TEMPLATE which is automatically proposed by GitHub when creating a new PR.

How to commit?

We enforce contributors behavior with commit messages to reference JIRA/GitHub issues.

Why?

Organized history and to create a CHANGE LOG for each version.

How does it work?

This script checks for a valid issue (JIRA or GitHub) reference and fails the build otherwise with the message

Your commit message should start with a JIRA issue ('JIRA-1111') or a GitHub issue ('#39')
with a following colon(:).
i.e. 'MGMT-42: Summary of the commit message'
You can also ignore the ticket checking with 'NO-ISSUE' for master only.

It will search for a commit message containing a valid JIRA/GitHub issue notation or "NO-ISSUE" in case there's no ticket.

Examples

  1. JIRA reference without a Bugzilla link

    MGMT-6075: Implement ResetHostValidation API call

  2. No reference

    NO-ISSUE: allow GitHub-created reverts to be used

  3. GitHub reference

    #1 Fixing the very first GitHub issue

    NOTE: The following is also correct

    Fixing the very first GitHub issue

[...]

Closes: #1

Best practices

See the Kubernetes guidelines Specifically:

  1. Smaller is better
  2. Squashing
  3. Commit message guidelines

Testing

More information is available here: Assisted Installer Testing