From 3a4c7293712ed669bc60190677b7a3058f1cac1b Mon Sep 17 00:00:00 2001 From: Jean-Pascal MEWENEMESSE Date: Mon, 4 May 2026 17:22:18 +0200 Subject: [PATCH 1/7] feat: added contributing md file that explain the contribution flow for TOSIT --- CONTRIBUTING.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..93c0d95 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,84 @@ +# Contributing to OKDP + +Thank you for your interest in contributing to OKDP! + +## How to Contribute + +### Reporting Issues + +- Use GitHub Issues on the relevant repository +- Use the provided issue templates (bug report, feature request) +- For security vulnerabilities, see [SECURITY.md](SECURITY.md) + +### Contributing Documentation + +- Follow the existing repository structure and naming conventions +- Use the provided templates when available +- Keep guides focused on one component + +### Contributing Code + +The workflow depends on the visibility of the target repository. + +#### Public repositories (open-source contribution) + +The default workflow for everyone is **fork-based**: + +1. **Fork** the repository on GitHub +2. Clone your fork and create a feature branch from `main` +3. Make your changes +4. Ensure CI passes, if configured (lint, tests, build...) +5. Submit a Pull Request from your fork to the upstream `main` +6. The Pull Request must be related to an issue + +> **Maintainers only (urgent/quick fixes):** maintainers may create a branch directly in the upstream repository instead of forking, but only for time-sensitive changes. The fork-based workflow remains the default for all other contributions. + +#### Private repositories (internal team contribution) + +1. Create a branch **directly from `main`** in the repository (no fork needed) +2. Make your changes +3. Ensure CI passes, if configured (lint, tests, build) +4. Submit a Pull Request to `main` +5. The Pull Request must be related to an issue + +### Commit Messages + +Follow [Conventional Commits](https://www.conventionalcommits.org/): + +``` +feat: add OIDC support for Trino +fix: correct S3 endpoint in hive-metastore values +docs: update airflow INSTALL.md with gitSync config +chore: bump cert-manager to v1.17.1 +``` + +### Pull Request Process + +- Bug fixes and minor changes require at least 1 maintainer approval (lazy consensus) +- Feature PRs and documentation PRs are reviewed and approved at the **TOSIT Contributors Meeting**. Please, plan your submissions accordingly +- All CI checks must pass if configured +- Keep PRs focused, one change per PR +- Before merge, **squash your commits** into meaningful units and **rebase your branch** on top of the latest `main`. Use `git push --force-with-lease` to update the PR. + +## Getting Help + +For questions, ideas, or technical discussions, use [OKDP GitHub Discussions](https://github.com/orgs/OKDP/discussions). + +## Repository Map + +| Repository | What to Contribute | +| ----------------------------------------------------------- | ---------------------------------------------- | +| [OKDP/OKDP](https://github.com/OKDP/OKDP) | Project-level docs, governance, roadmap | +| [OKDP/helm-handbook](https://github.com/OKDP/helm-handbook) | Helm chart install guides and values | +| [OKDP/okdp-sandbox](https://github.com/OKDP/okdp-sandbox) | Sandbox environment | +| OKDP/hive-metastore, spark-history-server, etc. | Module source code, Helm charts, Docker images | + +## Contributor License Agreement (CLA) + +Before your first contribution can be merged, you must sign the OKDP CLA (one-time requirement). + + + +## Code of Conduct + +This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). \ No newline at end of file From 06a19a93aa4e4804ddf0dfab4b00d1f10fe2d18f Mon Sep 17 00:00:00 2001 From: Jean-Pascal MEWENEMESSE Date: Tue, 5 May 2026 11:02:02 +0200 Subject: [PATCH 2/7] governance: added repo up to date steps, updated the pull request process --- CONTRIBUTING.md | 39 ++++++++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 93c0d95..adcb08a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,9 +12,15 @@ Thank you for your interest in contributing to OKDP! ### Contributing Documentation -- Follow the existing repository structure and naming conventions -- Use the provided templates when available -- Keep guides focused on one component +The helm-handbook contains two types of guides: + +- **Full-stack deployment guide** (`README.md`): end-to-end installation covering all modules in order +- **Prerequisites guide** (`modules/prerequisites/README.md`): infrastructure umbrella chart and post-install steps + +When contributing: +- Keep each guide focused on its scope (full-stack or prerequisites) +- Use the provided PR template +- Values files must contain real, working values, no placeholders ### Contributing Code @@ -22,24 +28,31 @@ The workflow depends on the visibility of the target repository. #### Public repositories (open-source contribution) -The default workflow for everyone is **fork-based**: +The default workflow for everyone is fork-based: 1. **Fork** the repository on GitHub 2. Clone your fork and create a feature branch from `main` 3. Make your changes -4. Ensure CI passes, if configured (lint, tests, build...) +4. Ensure CI passes, if configured (lint, tests, build) 5. Submit a Pull Request from your fork to the upstream `main` -6. The Pull Request must be related to an issue > **Maintainers only (urgent/quick fixes):** maintainers may create a branch directly in the upstream repository instead of forking, but only for time-sensitive changes. The fork-based workflow remains the default for all other contributions. +**Keeping your fork up to date:** + +```sh +git fetch upstream +git checkout main +git merge upstream/main +git push origin main +``` + #### Private repositories (internal team contribution) 1. Create a branch **directly from `main`** in the repository (no fork needed) 2. Make your changes 3. Ensure CI passes, if configured (lint, tests, build) 4. Submit a Pull Request to `main` -5. The Pull Request must be related to an issue ### Commit Messages @@ -54,11 +67,15 @@ chore: bump cert-manager to v1.17.1 ### Pull Request Process -- Bug fixes and minor changes require at least 1 maintainer approval (lazy consensus) -- Feature PRs and documentation PRs are reviewed and approved at the **TOSIT Contributors Meeting**. Please, plan your submissions accordingly +- If your work is still in progress, open a **Draft PR**. This allows early feedback and makes your work visible to the team without triggering a formal review. Convert it to a regular PR when it is ready. +- **All PRs must be linked to an issue**. If no relevant issue exists, open one before submitting your PR. Trivial fixes (typos, broken links) may skip this. +- Bug fixes and minor changes require at least 1 maintainer approval +- Feature PRs and documentation PRs are reviewed and approved at the **TOSIT Contributors Meeting**. Please plan your submissions accordingly - All CI checks must pass if configured -- Keep PRs focused, one change per PR -- Before merge, **squash your commits** into meaningful units and **rebase your branch** on top of the latest `main`. Use `git push --force-with-lease` to update the PR. +- Keep PRs focused: one concern per PR. If your PR touches multiple unrelated things, split it. +- Keep PRs under 500 lines of meaningful changes where possible. If your PR is larger, explain in the description why it cannot be split. Large PRs that are difficult to review may be sent back for splitting. +- During review, address feedback by adding new commits. Do not rewrite history or force-push. This preserves reviewer context. +- Once your PR is approved, **squash your commits** into meaningful units and **rebase your branch** on top of the latest `main`. Then use `git push --force-with-lease` to update the PR before merge. ## Getting Help From 210c34729b2300b90ab1e662b74bef3297fd88cb Mon Sep 17 00:00:00 2001 From: Jean-Pascal MEWENEMESSE Date: Tue, 5 May 2026 15:56:27 +0200 Subject: [PATCH 3/7] feat: Update CONTRIBUTING.md Co-authored-by: Romain Pignolet --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index adcb08a..7f398f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,6 +41,7 @@ The default workflow for everyone is fork-based: **Keeping your fork up to date:** ```sh +git remote add upstream https://github.com/OKDP/.git # if remote does not exist git fetch upstream git checkout main git merge upstream/main From 3245831057b30734c0fe53e6ff86d46a795dc653 Mon Sep 17 00:00:00 2001 From: Jean-Pascal MEWENEMESSE Date: Tue, 5 May 2026 15:57:41 +0200 Subject: [PATCH 4/7] feat: Update CONTRIBUTING.md Added OKDP to make sure we are talking about OKDP contributors meeting Co-authored-by: Romain Pignolet --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f398f4..4806354 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,7 +71,7 @@ chore: bump cert-manager to v1.17.1 - If your work is still in progress, open a **Draft PR**. This allows early feedback and makes your work visible to the team without triggering a formal review. Convert it to a regular PR when it is ready. - **All PRs must be linked to an issue**. If no relevant issue exists, open one before submitting your PR. Trivial fixes (typos, broken links) may skip this. - Bug fixes and minor changes require at least 1 maintainer approval -- Feature PRs and documentation PRs are reviewed and approved at the **TOSIT Contributors Meeting**. Please plan your submissions accordingly +- Feature PRs and documentation PRs are reviewed and approved at the **TOSIT OKDP Contributors Meeting**. Please plan your submissions accordingly - All CI checks must pass if configured - Keep PRs focused: one concern per PR. If your PR touches multiple unrelated things, split it. - Keep PRs under 500 lines of meaningful changes where possible. If your PR is larger, explain in the description why it cannot be split. Large PRs that are difficult to review may be sent back for splitting. From 1767ffb1b49f37c23d6cb1d97984d910d3b1fcab Mon Sep 17 00:00:00 2001 From: Jean-Pascal MEWENEMESSE Date: Wed, 6 May 2026 09:23:37 +0200 Subject: [PATCH 5/7] feat: removed bloc related to helm-handbook to keep the file as generic as possible, added git commit --fixup tip --- CONTRIBUTING.md | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4806354..0d37b1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,18 +10,6 @@ Thank you for your interest in contributing to OKDP! - Use the provided issue templates (bug report, feature request) - For security vulnerabilities, see [SECURITY.md](SECURITY.md) -### Contributing Documentation - -The helm-handbook contains two types of guides: - -- **Full-stack deployment guide** (`README.md`): end-to-end installation covering all modules in order -- **Prerequisites guide** (`modules/prerequisites/README.md`): infrastructure umbrella chart and post-install steps - -When contributing: -- Keep each guide focused on its scope (full-stack or prerequisites) -- Use the provided PR template -- Values files must contain real, working values, no placeholders - ### Contributing Code The workflow depends on the visibility of the target repository. @@ -75,9 +63,11 @@ chore: bump cert-manager to v1.17.1 - All CI checks must pass if configured - Keep PRs focused: one concern per PR. If your PR touches multiple unrelated things, split it. - Keep PRs under 500 lines of meaningful changes where possible. If your PR is larger, explain in the description why it cannot be split. Large PRs that are difficult to review may be sent back for splitting. -- During review, address feedback by adding new commits. Do not rewrite history or force-push. This preserves reviewer context. +- During review, address feedback by adding new commits. Do not rewrite history or force-push. This preserves reviewer context. If you plan to` squash` later, you can use` git commit --fixup`. - Once your PR is approved, **squash your commits** into meaningful units and **rebase your branch** on top of the latest `main`. Then use `git push --force-with-lease` to update the PR before merge. +> **Tip:** If you have been using `git commit --fixup` during review, you can run `git rebase --autosquash` to squash automatically. + ## Getting Help For questions, ideas, or technical discussions, use [OKDP GitHub Discussions](https://github.com/orgs/OKDP/discussions). @@ -99,4 +89,4 @@ Before your first contribution can be merged, you must sign the OKDP CLA (one-ti ## Code of Conduct -This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). \ No newline at end of file +This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). From dab931a16607b08c5aa300b44901bbedd32648be Mon Sep 17 00:00:00 2001 From: Jean-Pascal MEWENEMESSE Date: Tue, 12 May 2026 10:12:29 +0200 Subject: [PATCH 6/7] gov: added OKDP cross-repo PR dashboard, removed helm-handbook as it is currently blank, added TODO to replace CODE_OF_CONDUCT and SECURITY.md feature branch link --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d37b1e..4aff76c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,9 +6,10 @@ Thank you for your interest in contributing to OKDP! ### Reporting Issues + - Use GitHub Issues on the relevant repository - Use the provided issue templates (bug report, feature request) -- For security vulnerabilities, see [SECURITY.md](SECURITY.md) +- For security vulnerabilities, see [SECURITY.md](https://github.com/jpmewenemesse/.github/blob/5c7157ad899e1219b1e3d1fbd8b69d57d9dbad78/SECURITY.md) ### Contributing Code @@ -56,6 +57,8 @@ chore: bump cert-manager to v1.17.1 ### Pull Request Process +Before opening a PR, you can browse [all open OKDP pull requets](https://github.com/pulls?user=OKDP) for a cross-repo overview. + - If your work is still in progress, open a **Draft PR**. This allows early feedback and makes your work visible to the team without triggering a formal review. Convert it to a regular PR when it is ready. - **All PRs must be linked to an issue**. If no relevant issue exists, open one before submitting your PR. Trivial fixes (typos, broken links) may skip this. - Bug fixes and minor changes require at least 1 maintainer approval @@ -77,7 +80,6 @@ For questions, ideas, or technical discussions, use [OKDP GitHub Discussions](ht | Repository | What to Contribute | | ----------------------------------------------------------- | ---------------------------------------------- | | [OKDP/OKDP](https://github.com/OKDP/OKDP) | Project-level docs, governance, roadmap | -| [OKDP/helm-handbook](https://github.com/OKDP/helm-handbook) | Helm chart install guides and values | | [OKDP/okdp-sandbox](https://github.com/OKDP/okdp-sandbox) | Sandbox environment | | OKDP/hive-metastore, spark-history-server, etc. | Module source code, Helm charts, Docker images | @@ -89,4 +91,5 @@ Before your first contribution can be merged, you must sign the OKDP CLA (one-ti ## Code of Conduct -This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). + +This project follows the [Contributor Covenant Code of Conduct](https://github.com/jpmewenemesse/.github/blob/ded9f3fa2ab8f489e68f968f4104e4597d5ab469/CODE_OF_CONDUCT.md). From 52f743be5449c3775de4cde5f9439a20c21deefa Mon Sep 17 00:00:00 2001 From: Jean-Pascal MEWENEMESSE Date: Wed, 13 May 2026 09:29:52 +0200 Subject: [PATCH 7/7] feat: commented feature branch reference --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4aff76c..dbf8381 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ Thank you for your interest in contributing to OKDP! - Use GitHub Issues on the relevant repository - Use the provided issue templates (bug report, feature request) -- For security vulnerabilities, see [SECURITY.md](https://github.com/jpmewenemesse/.github/blob/5c7157ad899e1219b1e3d1fbd8b69d57d9dbad78/SECURITY.md) + ### Contributing Code @@ -92,4 +92,4 @@ Before your first contribution can be merged, you must sign the OKDP CLA (one-ti ## Code of Conduct -This project follows the [Contributor Covenant Code of Conduct](https://github.com/jpmewenemesse/.github/blob/ded9f3fa2ab8f489e68f968f4104e4597d5ab469/CODE_OF_CONDUCT.md). +