Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

52 lines (32 loc) · 2.53 KB
Raw

Contributing Guidelines

Contributions are welcome via GitHub Pull Requests. This document outlines the process to help get your contribution accepted.

Any type of contribution is welcome: new features, bug fixes, documentation improvements, etc.

How to Contribute

  1. Fork this repository, develop, and test your changes.
  2. Submit a pull request.

Requirements

When submitting a PR make sure that:

  • It must pass CI jobs for linting and test the changes (if any).
  • It must follow container best practices.
  • The title of the PR is clear enough.
  • If necessary, add information to the repository's README.md.

Sign Your Work

The sign-off is a simple line at the end of the explanation for a commit. All commits needs to be signed. Your signature certifies that you wrote the patch or otherwise have the right to contribute the material. The rules are pretty simple, you only need to certify the guidelines from developercertificate.org.

Then you just add a line to every git commit message:

Signed-off-by: Mohammad Abdolirad <[email protected]>

Use your real name (sorry, no pseudonyms or anonymous contributions.)

If you set your user.name and user.email git configs, you can sign your commit automatically with git commit -s.

Note: If your git config information is set properly then viewing the git log information for your commit will look something like this:

Author: Mohammad Abdolirad <[email protected]>
Date:   Sat Sep 3 08:10:15 2022 +0200

    Update README

    Signed-off-by: Mohammad Abdolirad <[email protected]>

Notice the Author and Signed-off-by lines match. If they don't your PR will be rejected by the automated DCO check.

PR Approval and Release Process

  1. Changes are manually reviewed by Dockage team members usually within a business day or weekend.
  2. Once the changes are accepted, the PR is tested (if needed) into the Dockage CI pipeline, the container is deployed and tested (verification and functional tests) using docker-compose and Helm (if there is an associated Helm Chart).
  3. The PR is merged by the reviewer(s) in the GitHub main branch.
  4. Then our CI/CD system is going to push the container image to the different registries including the recently merged changes.

NOTE: Please note that, in terms of time, may be a slight difference between the appearance of the code in GitHub and the image with the changes in the different registries.