We welcome all contributions to the project!
General guidelines about contributing to the SF-Operator can be found in this document. For further details about the code base, testing and hacking the project, please see the Developer documentation.
The main repository of the project is hosted at softwarefactory-project.io.
The custom container images used by the SF-Operator are defined in the container-pipeline project and published on quay.io.
Use the git-review workflow to interact with these projects.
Repositories with the same name on GitHub are mirrors from softwarefactory-project.io, no pull request will be accepted there.
The MicroShift deployment Ansible role is hosted on GitHub. Pull Requests are welcome there.
Any large contribution aiming to modify or implement a functionality must be first validated by the community with an Architectural Decision Record (ADR).
ADRs can be created following the template found in the docs/adr directory of the sf-operator repository.
Before submitting a change or a patch chain for review, please consider the following checklist:
- Are the commit messages clear and explanatory?
- Do the changes need to be documented in the changelog?
- Do the changes cover any required modification of the existing documentation? (see guidelines below)
- Are the changes tested? We do not require unit testing but do expect functional testing coverage.
The documentation is written in Markdown, as implemented by GitHub Pages. Please refer to this documentation to check what elements are supported.
Any change that implements a new feature or significantly changes an existing one must be reflected in the documentation, in the impacted section(s).
The API documentation is auto-generated with crd-ref-docs.
Running make or make build or make build-api-doc will update the API documentation if needed.
For now the CLI documentation must be updated by hand.