-
Notifications
You must be signed in to change notification settings - Fork 1
feat: added CONTRIBUTING.md for OKDP contribution workflow #4
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
jpmewenemesse
wants to merge
5
commits into
OKDP:main
Choose a base branch
from
jpmewenemesse:feat/added-contributing-file
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.
+92
−0
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
3a4c729
feat: added contributing md file that explain the contribution flow f…
jpmewenemesse 06a19a9
governance: added repo up to date steps, updated the pull request pro…
jpmewenemesse 210c347
feat: Update CONTRIBUTING.md
jpmewenemesse 3245831
feat: Update CONTRIBUTING.md
jpmewenemesse 1767ffb
feat: removed bloc related to helm-handbook to keep the file as gener…
jpmewenemesse 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
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 |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| # 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 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` | ||
|
|
||
| > **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 remote add upstream https://github.com/OKDP/<repo>.git # if remote does not exist | ||
| git fetch upstream | ||
|
jpmewenemesse marked this conversation as resolved.
|
||
| 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` | ||
|
|
||
| ### 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 | ||
|
|
||
| - 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 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. | ||
| - 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. | ||
|
jpmewenemesse marked this conversation as resolved.
|
||
|
|
||
| > **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). | ||
|
|
||
| ## 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 | | ||
|
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. pas encore public, donc a supprimer |
||
| | [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). | ||
|
|
||
| <!-- TODO: add link to CLA signing process once finalized --> | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
non-explicit action described here. Could be misleading