-
Notifications
You must be signed in to change notification settings - Fork 64
K8SPG-744 Updated Contributing guide with the steps to build and deploy the Operator #1208
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
K8SPG-744 Updated Contributing guide with the steps to build and deploy the Operator #1208
Conversation
CONTRIBUTING.md
Outdated
@@ -1,8 +1,10 @@ | |||
# Contributing to Percona Operator for PostgreSQL | |||
|
|||
We welcome contributions to the Percona Operator for PostgreSQL project and we're glad that you would like to become a Percona community member and participate in keeping open source open. for you to help us improve the Operator, please follow the guidelines below. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
small typo: For you to help us improve
, needs capital after full stop.
CONTRIBUTING.md
Outdated
5. [Build a custom Operator image based on your changes](#build-a-custom-operator-image) to verify that they work | ||
6. [Update deployment manifests](#update-deployment-manifests) to reflect your changes | ||
7. [Run e2e tests](#run-e2e-tests) | ||
) to verify your changes are stable and robust. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we have a formatting error here. E.g. the parenthesis here seems that is never opened.
Co-authored-by: George Kechagias <[email protected]>
Do we want to add instructions how to run unit tests and ask contributors to add them? |
I think we can catch the need for unit testing during code reviews. Also, running unit tests is generally universal in golang and even our makefile hints that. So I think it is not needed. |
CHANGE DESCRIPTION
Problem:
Contributors don't know how to build the Operator image and then deploy it to view their changes in action.
This PR extends the Contributing guide with the missing steps.
Short explanation of the problem.
Cause:
Short explanation of the root cause of the issue if applicable.
Solution:
Short explanation of the solution we are providing with this PR.
CHECKLIST
Jira
Needs Doc
) and QA (Needs QA
)?Tests
Config/Logging/Testability