From 53a969c24d8fa9ca8cc3cd1a58297abc7f205bd2 Mon Sep 17 00:00:00 2001 From: jannfis Date: Wed, 5 Aug 2020 14:39:02 +0200 Subject: Add contribution docs --- docs/contributing/development.md | 41 ++++++++++++++++++++++++++++++++++++++++ docs/contributing/start.md | 14 ++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 docs/contributing/development.md create mode 100644 docs/contributing/start.md (limited to 'docs/contributing') diff --git a/docs/contributing/development.md b/docs/contributing/development.md new file mode 100644 index 0000000..3ff1123 --- /dev/null +++ b/docs/contributing/development.md @@ -0,0 +1,41 @@ +# Developing + +## Requirements + +Getting started to develop ArgoCD Image Updater shouldn't be too hard. All that +is required is a simple build toolchain, consisting of: + +* Golang v1.14 +* GNU make +* Docker (for building images, optional) +* Kustomize (for building K8s manifests, optional) + +## Makefile targets + +Most steps in the development process are scripted in the `Makefile`, the most +important targets are: + +* `all` - this is the default target, and will build the `argocd-image-updater` + binary. + +* `lint` - this will run `golangci-lint` and ensure code is linted correctly. + +* `test` - this will run all the unit tests + +* `image` - this will build the Docker image + +* `manifests` - this will build the installation manifests for Kubernetes from + the Kustomize sources + +## Sending Pull Requests + +To send a pull request, simply fork the +[GitHub repository](https://github.com/argoproj-labs/argocd-image-updater) +to your GitHub account, create a new branch, commit & push your changes and then +send the PR over for review. + +When developing new features or fixing bugs, please make sure that your code is +accompanied by appropriate unit tests. If you are fixing a bug, please also +include a unit test for that specific bug. + +Also, please make sure that your code is correctly linted. diff --git a/docs/contributing/start.md b/docs/contributing/start.md new file mode 100644 index 0000000..604e89f --- /dev/null +++ b/docs/contributing/start.md @@ -0,0 +1,14 @@ +# Contributing to ArgoCD Image Updater + +Contributing to ArgoCD Image Updater is easy! You can contribute in a number of +ways, e.g. + +* raise bug reports in the issue tracker, +* send your ideas for enhancing ArgoCD Image Update, +* participate with your knowledge in existing issues, +* vote for existing feature requests, +* send Pull Requests for the docs, for the code, for the build toolchain, etc + +Everyone is welcome to contribute! + +If you just want to show some appreciation, make sure to star our GitHub repo. \ No newline at end of file -- cgit v1.2.3