diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..433d001 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# 📖 Guidelines + +- Pull requests should be created on the master branch. + +# ⚒️ Building and Testing the Sources + +## Build JFrog Registry Operator + +Make sure Go is installed by running: + +``` +go version +``` + +Clone the sources and CD to the root directory of the project: + +``` +git clone https://github.com/jfrog/jfrog-registry-operator.git +cd jfrog-registry-operator +``` + +Build the sources as follows: + +Before running the application, generate mocks by running the following command from within the root directory of the project: + +```sh +make generate +make manifests +``` + +To run the code, follow these steps: + +```sh +kubectl apply -f config/crd/bases +``` + +```sh +go run main.go +``` + +Once operator is in running state, configure artifactoryUrl, refreshTime, namespaceSelector and secretMetadata in [secretrotator.yaml](https://github.com/jfrog/jfrog-registry-operator/blob/main/charts/jfrog-registry-operator/examples/secretrotator.yaml) diff terminal + +```sh +kubectl apply -f config/samples/jfrog_v1alpha1_secretrotator.yaml` +``` diff --git a/README.md b/README.md index e62067f..e65f917 100644 --- a/README.md +++ b/README.md @@ -94,9 +94,12 @@ kubectl get SecretRotator Follow [monitoring setup docs](./config/monitoring/). -## How to contribute -1. Fork and clone the repo -2. Add your changes, make sure you update new specs by running `make generate` and `make manifests` -3. Run locally : `make install` -4. Apply CR(`kubectl apply -f config/samples/jfrog_v1alpha1_secretrotator.yaml`) and check application is working as expected -4. Once changes are tested raise a PR, [Ref](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop) +## 🔥 Reporting issues + +Please help us improve Frogbot by [reporting issues](https://github.com/jfrog/jfrog-registry-operator/issues/new/choose) you encounter. + +
+ +## 💻 Contributions + +We welcome pull requests from the community. To help us improve this project, please read our [Contribution](./CONTRIBUTING.md#-guidelines) guide.