Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (52 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

73 lines (52 loc) · 3.12 KB

Contributing to build-tasks-dockerfiles

Table of Contents

Project Overview

This repository serves as a repository for several components used in Konflux. Therefore, everybody should follow its Code of Conduct.

This repository contains Dockerfiles for images used in build-related tasks managed by the Konflux Build Team. See the CODEOWNERS file for more information.

How to Report Issues

  • We encourage early communication for all types of contributions.
  • Before filing an issue, make sure to check if it is not reported already.
  • If the contribution is non-trivial (straightforward bugfixes, typos, etc.), please open an issue to discuss your plans and get guidance from maintainers.
  • Please fill out included issue templates with all applicable information.

How to Submit Pull Requests

Development Workflow

  1. Fork and Clone: Fork this repository and clone your fork
  2. Create Feature Branch: Create a new topic branch based on main
  3. Make Changes: Implement your changes
  4. Commit Changes: See commit guidelines

Pull Request Guidelines

Commit Requirements:

  • Write clear, descriptive commit titles. Should fit under 50 characters
  • Write meaningful commit descriptions with each line having less than 72 characters
  • Split your contribution into several commits if applicable, each should represent a logical chunk
  • Add line Assisted-by: <name-of-ai-tool> if you used an AI tool for your contribution
  • Sign-off your commits in order to certify that you adhere to Developer Certificate of Origin

Pull Request Content:

  • Title: Clear, descriptive title. Should fit under 72 characters.
  • Description: Explain the overall changes and their purpose, this should be a cover letter for your commits.
  • Testing: Describe how the changes were tested
  • Links: Reference related issues or upstream stories.

Remember:

  • Konflux is a community project and proper descriptions cannot be replaced by referencing a publicly inaccessible link to Jira or any other private resource.
  • Reviewers, other contributors and future generations might not have the same context as you have at the moment of PR submission.

Security Best Practices

  • Never commit secrets or keys to the repository
  • Never expose or log sensitive information

Review Process

Requirements for Approval:

  • All CI checks pass
  • Code review approval from maintainers

Review Criteria:

  • The contribution follows established patterns and conventions
  • Changes are tested and documented
  • Security best practices are followed

For any questions or help with contributing, please open an issue or reach out to the maintainers.