Skip to content

Add "Before You Contribute" section with IEP guidance#127

Merged
afritzler merged 1 commit into
mainfrom
enh/contrib-guide
Jun 8, 2026
Merged

Add "Before You Contribute" section with IEP guidance#127
afritzler merged 1 commit into
mainfrom
enh/contrib-guide

Conversation

@afritzler

@afritzler afritzler commented Jun 8, 2026

Copy link
Copy Markdown
Member

Proposed Changes

Add "Before You Contribute" section with IEP guidance.

Summary by CodeRabbit

  • Documentation
    • Enhanced contributing guide with a new "Before You Contribute" section providing clearer guidance on initiating contributions, including GitHub issue requirements and submission processes for larger changes.

Signed-off-by: Andreas Fritzler <andreas.fritzler@sap.com>
@afritzler afritzler requested a review from a team as a code owner June 8, 2026 15:02
@github-actions github-actions Bot added the size/S label Jun 8, 2026
@afritzler afritzler added the enhancement New feature or request label Jun 8, 2026
@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2961e407-2589-4d94-bc49-9713f26c787c

📥 Commits

Reviewing files that changed from the base of the PR and between 22a17f7 and 5350dec.

📒 Files selected for processing (1)
  • docs/community/contributing.md

📝 Walkthrough

Walkthrough

This PR adds a "Before You Contribute" section to the contributing guide that establishes an issue-first workflow requirement. Contributors are directed to tie work to existing GitHub issues, open new issues when needed, and use the enhancements repository with IEPs for larger proposals, with an initial issue opening required even for IEPs.

Changes

Contributor Guidance Documentation

Layer / File(s) Summary
Contributor guidance for issue-first workflow and IEPs
docs/community/contributing.md
New "Before You Contribute" section clarifies that contributors should tie work to existing issues, open new issues when needed, and use the enhancements repository with IEPs for larger or cross-cutting changes, requiring an initial issue even for an IEP.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding a 'Before You Contribute' section with IEP guidance to the documentation.
Description check ✅ Passed The description is minimal but adequately communicates the change. It matches the template structure with 'Proposed Changes' section, though the 'Fixes #' line is omitted.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch enh/contrib-guide

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@afritzler afritzler merged commit 9107dba into main Jun 8, 2026
7 checks passed
@afritzler afritzler deleted the enh/contrib-guide branch June 8, 2026 15:08
**IronCore Enhancement Proposals (IEPs)**. An IEP is the place to describe the motivation, design, and trade-offs
of a substantial idea or solution that affects one or more IronCore projects.
- **Even for an IEP, start with an issue.** Especially for new contributors, please open an issue in the
enhancements repository first to outline the idea and gather early feedback. This makes it much easier for

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
enhancements repository first to outline the idea and gather early feedback. This makes it much easier for
enhancements repository first to outline the idea and gather early feedback. This makes it much easier for

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants