-
Notifications
You must be signed in to change notification settings - Fork 68
[WIP] added contributing.md file to assist new contributors #946
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
Open
kernelpanic77
wants to merge
10
commits into
devfile:main
Choose a base branch
from
kernelpanic77:contribute
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+135
−0
Open
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
a53f8d8
added contributing.md file to assist new contributors
kernelpanic77 c8dc4a9
Merge branch 'devfile:main' into contribute
kernelpanic77 079f79b
Update docs/CONTRIBUTING.md
kernelpanic77 b171c16
Update docs/CONTRIBUTING.md
kernelpanic77 a370293
added contributing.md file to assist new contributors
kernelpanic77 1435065
Update docs/CONTRIBUTING.md
kernelpanic77 654a59f
Update docs/CONTRIBUTING.md
kernelpanic77 0c0520a
updated contributing.md
kernelpanic77 2d9d4c7
updated contributing.md
kernelpanic77 614092f
changes for contributing.md 'testing controller'
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev
Previous commit
changes for contributing.md 'testing controller'
- Loading branch information
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| # Contributing to Devworkspace-Operator | ||
| # Contributing to DevWorkspace Operator | ||
|
|
||
| Hello there! Thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here. | ||
| Hello there! Thank you for choosing to contribute to DevWorkspace Operator. Navigate through the following table of contents to learn more about contributing to the project. | ||
|
|
||
| - [Contributing to Devworkspace-Operator](#contributing-to-devworkspace-operator) | ||
| - [Contributing to DevWorkspace Operator](#contributing-to-devworkspace-operator) | ||
| - [How to Contribute](#how-to-contribute) | ||
| - [Set up your Development Environment](#set-up-your-development-environment) | ||
| - [Running the controller locally.](#running-the-controller-locally) | ||
|
|
@@ -12,11 +12,11 @@ Hello there! Thank you for choosing to the contributing to devfile/devworkspace- | |
| - [Signing-off on Commits](#signing-off-on-commits) | ||
|
|
||
| # How to Contribute | ||
| To contribute to the devworkspace-operator project, developers should follow the fork and pull request workflow. | ||
| To contribute to the DevWorkspace Operator project, developers should follow the [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) and [pull request workflow](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). | ||
| ## Set up your Development Environment | ||
|
|
||
|
|
||
| **1.** Fork [Devworkspace operator](https://github.com/devfile/devworkspace-operator) repository. | ||
| **1.** Fork [devworkspace-operator](https://github.com/devfile/devworkspace-operator) repository. | ||
|
|
||
| **2.** Clone your forked copy of the project. | ||
|
|
||
|
|
@@ -26,7 +26,7 @@ git clone https://github.com/<your-github-username>/devworkspace-operator.git | |
|
|
||
| #### Running the controller locally. | ||
|
|
||
| In the steps listed below, we set up the development environment using a minikube cluster. | ||
| In the steps listed below, we set up the development environment using a [minikube cluster](https://minikube.sigs.k8s.io/docs/start/). | ||
|
|
||
| **1.** Start the minikube cluster. | ||
|
|
||
|
|
@@ -51,10 +51,10 @@ export NAMESPACE="devworkspace-controller" | |
| ``` | ||
| make install_cert_manager. | ||
| ``` | ||
| Please note that the above step is not specific to minikube. The cert-manager is required for all deployments on kubernetes. | ||
| Please note that the above step is not specific to minikube. The cert-manager is required for all deployments on Kubernetes. | ||
|
|
||
|
|
||
| **5.** Install the dependencies for running the devworkspace-operator in your cluster. | ||
| **5.** Install the dependencies for running the DevWorkspace Operator in your cluster. | ||
|
|
||
| ``` | ||
| make install | ||
|
|
@@ -72,7 +72,7 @@ kubectl patch deployment/devworkspace-controller-manager --patch "{\"spec\":{\"r | |
| make run | ||
| ``` | ||
|
|
||
| This will run the devworkspace-controller in your local system. | ||
| This will run the devworkspace-controller on your local system. | ||
|
|
||
| **8.** Make your changes in the new branch and test the changes. | ||
|
|
||
|
|
@@ -81,20 +81,29 @@ This will run the devworkspace-controller in your local system. | |
|
|
||
| #### Test run the controller | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For the Test run the controller and Developing Webhooks sections, there is a missing newline for each instruction number, making everything appear as a paragraph. I think you need to add a newline between each number point. |
||
|
|
||
| **1.** Take a look samples devworkspace configuration in `./samples` folder. | ||
| **2.** Apply any of them by executing `kubectl apply -f ./samples/theia-latest.yaml -n <namespace>`. | ||
| **3.** As soon as devworkspace is started you're able to get IDE url by executing `kubectl get devworkspace -n <namespace>` | ||
| **1.** Take a look samples DevWorkspaces in the `./samples` directory. If you are uncertain on which one to try, use `theia-latest.yaml`. | ||
|
|
||
| **2.** Apply a sample by executing `kubectl apply -f ./samples/<SAMPLE-FILENAME> -n $NAMESPACE`. For instance, `kubectl apply -f ./samples/theia-latest.yaml -n $NAMESPACE`. | ||
|
|
||
| **3.** As soon as devworkspace is started you're able to get IDE url by executing `kubectl get devworkspace -n <namespace>`. | ||
|
|
||
| **4.** To check for the DevWorkspace status, execute `kubectl get dw -n $NAMESPACE -w`. | ||
|
|
||
| **5.** As soon as the DevWorkspace is started, an IDE url will appear from the output of `kubectl get dw -n $NAMESPACE -w`. This assumes that the DevWorkspace sample you chose includes an IDE. | ||
|
|
||
| #### Developing Webhooks | ||
|
|
||
| **1.** Make a change to the webhook. | ||
| **2.** Ensure the `DWO_IMG` environment variable points to your container image repository, eg. export `DWO_IMG=quay.io/aobuchow/dwo-webhook:next`. | ||
| **3.** Run `make docker restart` (assuming DWO is already deployed to the cluster, otherwise make docker install). | ||
|
|
||
|
|
||
| **2.** Ensure the `DWO_IMG` environment variable points to your container image repository, eg. export `DWO_IMG=quay.io/<username>/dwo-webhook:next`. | ||
|
|
||
|
|
||
| **3.** Run `make docker restart` (assuming DWO is already deployed to the cluster, otherwise run `make docker install`). | ||
| Wait for the webhook deployment to update with your image that contains your latest changes. | ||
| ## Signing-off on Commits | ||
|
|
||
| To contribute to this project, you must agree to the **code fo conduct** for each commit you make. | ||
| To contribute to this project, you must agree to the **code of conduct** for each commit you make. | ||
|
|
||
| See the [code of conduct](https://github.com/devfile/api/blob/main/CODE_OF_CONDUCT.md) file for the full text of what you must agree to. | ||
| To signify that you agree to the DCO for contributions, you simply add a line to each of your | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.