diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b3cb84766..fba845774 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,6 +12,8 @@ _Have you read the [devfile registry contributing guide](https://github.com/devf _Does this repository's tests pass with your changes?_ - [ ] Documentation _Does any documentation need to be updated with your changes?_ +- [ ] Check Tools Provider +_Have you tested the changes with existing tools, i.e. Odo, Che, Console? (See [devfile registry contributing guide](https://github.com/devfile/registry/blob/main/CONTRIBUTING.md) on how to test changes)_ ### How to test changes / Special notes to the reviewer: \ No newline at end of file diff --git a/.gitignore b/.gitignore index 3fc389d04..89fd267f1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ index-generator -registry-support/ \ No newline at end of file +registry-support/ +.idea/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83c08de9e..16a2250d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -92,3 +92,16 @@ To update a sample: 2) Find the entry for the sample you wish to update. 3) Make the necessary changes. 4) Open a pull request against this repository with your changes. + + +## How to Test Changes + +### Odo +`odo create` and `odo push` to test devfile changes. See [Odo Doc](https://odo.dev/docs/using-odo/create-component) for more details. + +### Che +Opening the URL `https://workspaces.openshift.com/#` in your browser should start a workspace where `exec` commands run successfully. Type `task+` in the IDE command palette to see the list of available commands. + +### Console +In developer view, create an application via `Import from Git`. Provide git repository Url and verify if the application can be built and ran successfully. +Note: Currently Console only works with devfile v2.2.0 samples with outer loop support.