From 23851d26cf0f70d1d116ddb14884a38856f23cd6 Mon Sep 17 00:00:00 2001 From: James Cocker Date: Tue, 23 Dec 2025 15:44:48 +0000 Subject: [PATCH 1/4] Added /'How to make a contribution to Galasa's webui/' Signed-off-by: James Cocker --- CONTRIBUTING.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 538e778f0..3fa119756 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -Welcome to Galasa! To learn more about contributing to this repository, please read this Contributor's Guide. +Welcome to Galasa! To learn more about contributing to [this repository](#how-to-make-a-contribution-to-the-main-galasa-repository), or [Galasa's webui](#how-to-make-a-contribution-to-galasas-webui), please read this Contributor's Guide. ## How can you contribute? @@ -19,7 +19,8 @@ Welcome to Galasa! To learn more about contributing to this repository, please r ### Contributing code - Ensure your contribution aligns with the project's roadmap. -- Check out open issues with the label `good first issue`. +- Check out open issues on [our Kanban](https://github.com/orgs/galasa-dev/projects/3), especially ones with the label `good first issue`. +- Other common labels include `webui`, `cli` or `REST API`. Typically, stories without one of these three tags will imply it's a change needing to be made to the main galasa repository. ### Abide by the contributions legal guidance To ship, all developer contributions must abide by the legal guidance detailed in the [Developer Certificate of Origin](./CONTRIBUTIONS.md) @@ -28,7 +29,7 @@ To ship, all developer contributions must abide by the legal guidance detailed i - Fix typos, improve examples, or enhance explanations. -## How to make a contribution? +## How to make a contribution to the main Galasa Repository ### Sign your commits @@ -40,7 +41,7 @@ This allows us to prove who made each change to the codebase. Each PR build has "Developer Certificate of Origin" [DCO](./CONTRIBUTIONS.md) checking turned on, so nothing will get delivered without signed commits. -If you forgot to sign one or all of your commits, you can squash your PR changes and force-push your branch. +If you forgot to sign one or all of your commits, you can squash your PR changes, sign them, then force-push your branch. ### Set up a fork of a repository @@ -230,3 +231,11 @@ git commit -s -S -m "Add a meaningful commit message" git push origin issue-number/contribution-description ``` 6. Open a pull request from your forked repository branch to the main branch of the 'galasa repository', and explain your changes. Refer to any stories which are relevent and explain why the change was made, what the change is, and anything else which reviewers would find helpful to understand the context of the change. + +## How to make a contribution to Galasa's webui + +1. Similarly to the main Galasa repository, commits [must be signed](#sign-your-commits). + +2. If you do not have access to your own Galasa service, either production or Minikube, development will be aided by access to one. To get access please [sign up](https://github.com/orgs/galasa-dev/teams/galasa-service1-users) to be a part of the galasa-service1-users team on Github. On that page there should be a request to join button, which will send a request to one of the maintainers, so please reach out on one of the us otherwise your request will be denied. For example, this could be done in the comments of a ticket you would like to do on [our Kanban](https://github.com/orgs/galasa-dev/projects/3). Next, go to https://galasa-service1.galasa.dev/ which will get you to authenticate via Dex, then you'll be added to the system with the 'viewer' role. + +3. After you've confirmed you have access to a Galasa service, please refer back to the [webui's readme.md](https://github.com/galasa-dev/webui/blob/main/README.md) to setup environment variables such as `GALASA_DEV_TOKEN`, `GALASA_API_SERVER_URL` and `NODE_EXTRA_CA_CERTS` or `NODE_USE_SYSTEM_CA`, then run the project as chosen. From 906211ddf617e127dd302a37698bed516bd40f6e Mon Sep 17 00:00:00 2001 From: James Cocker Date: Mon, 29 Dec 2025 14:16:25 +0000 Subject: [PATCH 2/4] Small wording changes Signed-off-by: James Cocker --- CONTRIBUTING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3fa119756..dc77b44ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -Welcome to Galasa! To learn more about contributing to [this repository](#how-to-make-a-contribution-to-the-main-galasa-repository), or [Galasa's webui](#how-to-make-a-contribution-to-galasas-webui), please read this Contributor's Guide. +Welcome to Galasa! To learn more about contributing to the Galasa project, please read this Contributor's Guide. ## How can you contribute? @@ -19,8 +19,8 @@ Welcome to Galasa! To learn more about contributing to [this repository](#how-to ### Contributing code - Ensure your contribution aligns with the project's roadmap. -- Check out open issues on [our Kanban](https://github.com/orgs/galasa-dev/projects/3), especially ones with the label `good first issue`. -- Other common labels include `webui`, `cli` or `REST API`. Typically, stories without one of these three tags will imply it's a change needing to be made to the main galasa repository. +- Check out open issues on [our Kanban board](https://github.com/orgs/galasa-dev/projects/3), especially ones with the label `good first issue`. +- Other common labels include `webui`, `cli` or `REST API`. Typically, stories without one of these three tags will imply it's a change needing to be made to this repository. ### Abide by the contributions legal guidance To ship, all developer contributions must abide by the legal guidance detailed in the [Developer Certificate of Origin](./CONTRIBUTIONS.md) @@ -29,7 +29,7 @@ To ship, all developer contributions must abide by the legal guidance detailed i - Fix typos, improve examples, or enhance explanations. -## How to make a contribution to the main Galasa Repository +## How to make a contribution to this Repository ### Sign your commits @@ -234,8 +234,8 @@ git push origin issue-number/contribution-description ## How to make a contribution to Galasa's webui -1. Similarly to the main Galasa repository, commits [must be signed](#sign-your-commits). +1. Similarly to the this repository, you must [fork the respository](#set-up-a-fork-of-a-repository) and [sign your commits](#sign-your-commits). -2. If you do not have access to your own Galasa service, either production or Minikube, development will be aided by access to one. To get access please [sign up](https://github.com/orgs/galasa-dev/teams/galasa-service1-users) to be a part of the galasa-service1-users team on Github. On that page there should be a request to join button, which will send a request to one of the maintainers, so please reach out on one of the us otherwise your request will be denied. For example, this could be done in the comments of a ticket you would like to do on [our Kanban](https://github.com/orgs/galasa-dev/projects/3). Next, go to https://galasa-service1.galasa.dev/ which will get you to authenticate via Dex, then you'll be added to the system with the 'viewer' role. +2. Having access to a Galasa service can help aid development of the web UI by removing the need to set up additional back-end services locally. To get access, please [sign up](https://github.com/orgs/galasa-dev/teams/galasa-service1-users) to be a part of the galasa-service1-users team on Github. On that page there should be a request to join button. This will send a request to one of the maintainers, so please reach out to the Galasa team via our support channels (see https://galasa.dev/support) otherwise your request will be denied. Alternatively, you could also read out directly on a ticket you would like to work on from [our Kanban board](https://github.com/orgs/galasa-dev/projects/3). Next, go to https://galasa-service1.galasa.dev/ which will get you to authenticate via GitHub, then you'll be added to the system with the 'viewer' role. 3. After you've confirmed you have access to a Galasa service, please refer back to the [webui's readme.md](https://github.com/galasa-dev/webui/blob/main/README.md) to setup environment variables such as `GALASA_DEV_TOKEN`, `GALASA_API_SERVER_URL` and `NODE_EXTRA_CA_CERTS` or `NODE_USE_SYSTEM_CA`, then run the project as chosen. From f4fcc792b5d640a3d8c5f122aeea15a16c2c270e Mon Sep 17 00:00:00 2001 From: James Cocker Date: Mon, 29 Dec 2025 14:23:38 +0000 Subject: [PATCH 3/4] Small punctuation addition Signed-off-by: James Cocker --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 304dd0c02..dc4d57e7d 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ When setting up galasa locally, you can either use [(1) our development containe ### (2) Manual set up Some tools will need to be installed in order to build this code locally. -See our install instructions [here](./developer-docs/install-pre-req-tools.md) +See our install instructions [here](./developer-docs/install-pre-req-tools.md). ### To build... From 78d9a21b73ec9548706d089f4b6d494083611178 Mon Sep 17 00:00:00 2001 From: James Cocker Date: Mon, 29 Dec 2025 15:35:15 +0000 Subject: [PATCH 4/4] Slightly amended webui instructions on how to join the galasa org Signed-off-by: James Cocker --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc77b44ab..a060be830 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -236,6 +236,6 @@ git push origin issue-number/contribution-description 1. Similarly to the this repository, you must [fork the respository](#set-up-a-fork-of-a-repository) and [sign your commits](#sign-your-commits). -2. Having access to a Galasa service can help aid development of the web UI by removing the need to set up additional back-end services locally. To get access, please [sign up](https://github.com/orgs/galasa-dev/teams/galasa-service1-users) to be a part of the galasa-service1-users team on Github. On that page there should be a request to join button. This will send a request to one of the maintainers, so please reach out to the Galasa team via our support channels (see https://galasa.dev/support) otherwise your request will be denied. Alternatively, you could also read out directly on a ticket you would like to work on from [our Kanban board](https://github.com/orgs/galasa-dev/projects/3). Next, go to https://galasa-service1.galasa.dev/ which will get you to authenticate via GitHub, then you'll be added to the system with the 'viewer' role. +2. Having access to a Galasa service can help aid development of the web UI by removing the need to set up additional back-end services locally. To get access, please reach out to the Galasa team via our support channels (see https://galasa.dev/support), or directly on a ticket you would like to work on from [our Kanban board](https://github.com/orgs/galasa-dev/projects/3). Next, go to https://galasa-service1.galasa.dev/ which will get you to authenticate via GitHub, then you'll be added to the system with the 'viewer' role. 3. After you've confirmed you have access to a Galasa service, please refer back to the [webui's readme.md](https://github.com/galasa-dev/webui/blob/main/README.md) to setup environment variables such as `GALASA_DEV_TOKEN`, `GALASA_API_SERVER_URL` and `NODE_EXTRA_CA_CERTS` or `NODE_USE_SYSTEM_CA`, then run the project as chosen.