This pull request includes several updates to documentation and build scripts for the automq-operator project. The most significant changes involve adding comprehensive contribution guidelines, updating the README with installation instructions, and modifying the Makefile to support image setting.
Documentation Enhancements:
CONTRIBUTING.md: Added a detailed guide on contributing to the automq-operator project, including sections on code and documentation contributions, workspace preparation, commit rules, and PR descriptions.
README.md: Updated with new sections on project goals, description, prerequisites, installation instructions for dependencies and the operator, and verification steps.
Build Script Updates:
Makefile: Added a new set-image target to update the image in the Helm chart values file.
README.md: Modified the make run command to include make generate before make manifests for generating API definitions.
This pull request includes several updates to documentation and build scripts for the
automq-operatorproject. The most significant changes involve adding comprehensive contribution guidelines, updating the README with installation instructions, and modifying the Makefile to support image setting.Documentation Enhancements:
CONTRIBUTING.md: Added a detailed guide on contributing to theautomq-operatorproject, including sections on code and documentation contributions, workspace preparation, commit rules, and PR descriptions.README.md: Updated with new sections on project goals, description, prerequisites, installation instructions for dependencies and the operator, and verification steps.Build Script Updates:
Makefile: Added a newset-imagetarget to update the image in the Helm chart values file.README.md: Modified themake runcommand to includemake generatebeforemake manifestsfor generating API definitions.