Skip to content

Latest commit

 

History

History
70 lines (42 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

70 lines (42 loc) · 3.53 KB
Raw

Rapidfort

Contributing Guidelines

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

Any contribution is welcome, from new features, bug fixes, tests, documentation improvements, or even adding images to the repository (if it's viable).

How to Contribute

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

NOTE: To make the Pull Requests' (PRs) testing and merging process more manageable, please submit changes to multiple images in separate PRs.

Technical Requirements

When submitting a PR, make sure that it:

  • Must pass CI jobs for changes on top of different k8s platforms, docker, and docker-compose. (Automatically done by the community-images CI/CD pipeline).

Sign Your Work

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

Then you add a line to every git commit message:

Signed-off-by: John Doe <john.doe@example.com>

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

Suppose 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 correctly set, then viewing the git log information for your commit will look something like this:

Author: John Doe <john.doe@example.com>
Date:   Thu Feb 2 11:41:15 2018 -0800

    Update README

    Signed-off-by: John Doe <john.doe@example.com>

Notice the Author and Signed-off-by lines match. If they don't, the DCO check will reject your PR automatically.

Documentation Requirements

  • An image must include README.md.
  • image_generator.sh generates README.md automatically from image.yml. Please run ./scripts/image_generator.sh after making changes in image-specific image.yml.
  • The title of the PR starts with the image name (e.g. [image/provider])

PR Approval and Release Process

  1. Changes are automatically linted and tested using Github actions.
  2. Community-images team members manually review changes.
  3. When the PR passes all tests, the reviewer(s) merge the PR in the GitHub master branch.
  4. Then our CI/CD system will push the image to the Rapidfort Dockerhub registry.

Testing

  1. Determine the types of tests you will need based on your image.
  2. Ensure tests exercise all workflows to ensure hardened images don't break in production.

Adding a new image to the repository

There are two major technical requirements to add a new image to our catalog:

  • Follow the same structure/patterns as the rest of the community-images images (you can find a basic scaffolding in the template directory).
  • Use an OSI approved license for all the software.

Please, note that we will need to check internally and evaluate the feasibility of adding the new solution to the catalog. Due to limited resources, this step could take some time.