Skip to content
This repository was archived by the owner on Jun 29, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (32 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 2.71 KB
Raw

Contributing to resource-broker

General Remarks

You are welcome to contribute content (code, documentation etc.) to this open source project.

There are some important things to know:

  1. You must comply to the license of this project, accept the Developer Certificate of Origin (see below) before being able to contribute. The acknowledgement to the DCO will usually be requested from you as part of your first pull request to this project.
  2. Please adhere to our Code of Conduct.
  3. If you plan to use generative AI for your contribution, please see our guideline for AI-generated code contributions.
  4. Not all proposed contributions can be accepted. Some features may fit another project better or don't fit the general direction of this project. Of course, this doesn't apply to most bug fixes, but a major feature implementation for instance needs to be discussed with one of the maintainers first. The best way would be to just open an issue to discuss the feature you plan to implement (make it clear that you intend to contribute).

Developer Certificate of Origin (DCO)

Contributors will be asked to accept a DCO before they submit the first pull request to this project, this happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.

How to Contribute

  1. Make sure the change is welcome (see General Remarks).
  2. Fork the repository and create a branch.
  3. Make your changes and verify them locally:
    • Run make check to run code generation, linting, and all tests.
    • See DEVELOPMENT.md for all available make targets.
  4. Commit using Conventional Commits format (e.g. feat:, fix:, chore:).
  5. Create a pull request.
  6. Follow the link posted by the CLA assistant to your pull request and accept it, as described above.
  7. Wait for code review and approval, possibly enhancing your change on request.

Development

Prerequisites: Go (see version in go.mod), Docker, kubectl.

Key commands:

  • make check — full validation (codegen + lint + test + test-e2e)
  • make test — unit tests
  • make test-e2e — end-to-end tests
  • make codegen — regenerate CRDs, RBAC, and DeepCopy after API type changes
  • make lint-fix — lint and auto-fix
  • make run — run broker locally with debug logging

See DEVELOPMENT.md for the full list.

License

By contributing, you agree that your contributions will be licensed under the Apache-2.0 License.