Skip to content

📖 Consolidate Metal3 Contributing guide in community repo#2894

Open
kashifest wants to merge 1 commit intometal3-io:mainfrom
Nordix:consolidate-contributing-guide
Open

📖 Consolidate Metal3 Contributing guide in community repo#2894
kashifest wants to merge 1 commit intometal3-io:mainfrom
Nordix:consolidate-contributing-guide

Conversation

@kashifest
Copy link
Copy Markdown
Member

This is the consolidation of Contributing guide where generic contributing guidelines are maintained in the community repo and individual repos only contain repo-specific information.

Fixes #

Checklist:

  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.
  • E2E tests have been added, if necessary.
  • Integration tests have been added, if necessary.

@metal3-io-bot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign lentzi90 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@metal3-io-bot metal3-io-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 8, 2026
@kashifest
Copy link
Copy Markdown
Member Author

/hold
Reviews are welcome but this should land after metal3-io/community#40 lands

@metal3-io-bot metal3-io-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 8, 2026
@tuminoid
Copy link
Copy Markdown
Member

tuminoid commented Jan 8, 2026

/cc @tuminoid

@metal3-io-bot metal3-io-bot requested a review from tuminoid January 8, 2026 12:25
Copy link
Copy Markdown
Member

@tuminoid tuminoid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty much same things mentioned as in CAPM3.

AGENTS.md reference for "technical contribution guide" or something needed.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@metal3-io-bot
Copy link
Copy Markdown
Contributor

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues will close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@metal3-io-bot metal3-io-bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 12, 2026
@tuminoid
Copy link
Copy Markdown
Member

/remove-lifecycle stale

@kashifest we need to follow-up on these repo specific updates.

@metal3-io-bot metal3-io-bot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 13, 2026
@kashifest kashifest force-pushed the consolidate-contributing-guide branch 2 times, most recently from 31b2662 to 7138c23 Compare April 14, 2026 06:56
@kashifest
Copy link
Copy Markdown
Member Author

@tuminoid @lentzi90 PTAL again

Comment thread CONTRIBUTING.md Outdated
This is the consolidation of Contributing guide where generic contributing guidelines are maintained in the community repo and individual repos only contain repo-specific information.

Signed-off-by: Kashif Khan <kashif.khan@est.tech>
@kashifest kashifest force-pushed the consolidate-contributing-guide branch from 7138c23 to 9557004 Compare April 16, 2026 07:04
@kashifest
Copy link
Copy Markdown
Member Author

/hold cancel

@metal3-io-bot metal3-io-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 16, 2026
Copy link
Copy Markdown
Member

@lentzi90 lentzi90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@metal3-io-bot metal3-io-bot added the lgtm Indicates that a PR is ready to be merged. label Apr 16, 2026
@tuminoid tuminoid requested a review from Copilot April 19, 2026 16:51
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Consolidates this repository’s contributing documentation by linking to the shared Metal3 community contributing guide and keeping only Baremetal Operator–specific policies locally.

Changes:

  • Replaces most repository-specific contributing text with links to the common Metal3 community CONTRIBUTING guide sections (versioning, branches, backporting, release process).
  • Keeps Baremetal Operator–specific maintenance/backporting notes and points release steps to docs/releasing.md.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTING.md
Comment on lines +24 to +25
**Note**: The test module and experiments do not provide any backward
compatible guarantees.
Copy link

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The note mentions "experiments" not providing backward compatibility guarantees, but this repository doesn't appear to have an experiments module/directory. This makes the guidance confusing/outdated; consider removing the "experiments" reference or pointing to the actual location/name used in this repo (if any).

Suggested change
**Note**: The test module and experiments do not provide any backward
compatible guarantees.
**Note**: The test module does not provide any backward compatible
guarantees.

Copilot uses AI. Check for mistakes.
Comment thread CONTRIBUTING.md
@@ -1,148 +1,52 @@
# How to Contribute
# How to Contribute to Baremetal Operator
Copy link

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR description includes an unfinished "Fixes #" reference. Please either link the issue being fixed (e.g. "Fixes #123") so it auto-closes on merge, or remove the placeholder if there's no associated issue.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants