docs: add CONTRIBUTING.md file.

This closes #517.

Author: buehler

.github/workflows/gh-pages.yml

@@ -33,6 +33,13 @@ jobs:
           output: public/index.html
           github-corners: https://github.com/buehler/dotnet-operator-sdk
 
+      - name: Build Contribution
+        uses: jaywcjlove/markdown-to-html-cli@main
+        with:
+          source: CONTRIBUTING.md
+          output: public/contribution.html
+          github-corners: https://github.com/buehler/dotnet-operator-sdk
+
       - name: Build KubeOps
         uses: jaywcjlove/markdown-to-html-cli@main
         with:

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing to KubeOps
+
+First of all, thank you for considering contributing to KubeOps.
+This is an open souce project and shall be driven by the community.
+
+This document describes how contributions may be done and what is required
+to develop on KubeOps.
+
+## Creating/Reporting Issues
+
+Feel free to open an issue in the [issues section](https://github.com/buehler/dotnet-operator-sdk/issues).
+There are three issue templates:
+- Bug: to report an issue/bug that prevents usage or is an inconvenience of KubeOps
+- Feature request: to report a new feature that would enhance KubeOps
+- Documentation: to report missing / wrong documentation
+
+Please search through the already created issues to find similarities.
+
+## Creating Pull Requests
+
+To directly contribute to the solution, create a fork of the repository
+and implement your addition. Please keep in mind that reviewing takes some
+time and is not done instantly.
+
+Please adhere to the linting rules and the general code style in the repository.
+Also, add tests for your changes to ensure that the system works well
+when other changes happen.
+
+The PR can have any name, but it would be nice if you adhere to
+the repositories standard naming. Please name your PR
+with [Convential Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary).
+
+**NOTE for breaking changes**: please state breaking changes
+in the PR description. The review process will be faster when
+breaking changes are well documented.
+
+A few examples:
+- "fix: Null exception during watcher process"
+- "feat(core): Add new functionality"
+- "feat(testing): expose kubernetes client for testing"
+- "refactor: changed this and that"
+- "docs: Add docs about KubeOps core"
+
+The PR will be squashed and merged into the default branch.
+
+## Local Development
+
+To setup a local development environment, you'll need to perform the follwing steps:
+
+- Check out the repository (or your fork)
+- If you want to run the Operator locally, you'll need some Kubernetes instance.
+  This can be any Kubernetes instance you'd like:
+  - Local Kubernetes in Docker for Mac/Windows
+  - minikube / any other local Kubernetes
+  - Deployed Kubernetes (e.g. GCP Kubernetes instance)
+- You can now code your stuff.
+- `tests/KubeOps.TestOperator` is a developed small operator that can be run
+  locally to test your implementations.
+- Write tests for your changes
+- Build the whole solution and check for linting errors / warnings.
+  **NOTE** that any warning will result in an error when building
+  with `Release` configuration.
+- Do not change the linting rules without creating a discussion/issue first.

README.md

@@ -21,6 +21,16 @@ and each package contains a README.md with further information/documentation.
 ## Contribution
 
 If you want to contribute, feel free to open a pull request or write issues :-)
+Read more about contribution (especially for setting up your local environment)
+in the [CONTRIBUTING file](./CONTRIBUTING.md).
+
+Short wrapup:
+- Check out the code
+- Develop on KubeOps
+- Use some Kubernetes to run the test operator against
+- Create tests
+- Build the whole solution (lint warnings will result in an error)
+- Open PR
 
 ## Motivation
 

res/docs_index.md

@@ -22,6 +22,16 @@ below.
 ## Contribution
 
 If you want to contribute, feel free to open a pull request or write issues :-)
+Read more about contribution (especially for setting up your local environment)
+in the [CONTRIBUTING file](./contribution.html).
+
+Short wrapup:
+- Check out the code
+- Develop on KubeOps
+- Use some Kubernetes to run the test operator against
+- Create tests
+- Build the whole solution (lint warnings will result in an error)
+- Open PR
 
 ## Motivation