Skip to content

Commit b067a38

Browse files
committed
Add back "Before You Contribute" guide
Signed-off-by: Daniel Gonzalez Nothnagel <daniel.gonzalez.nothnagel@sap.com>
1 parent 0118ef5 commit b067a38

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

docs/contributing.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,23 @@ Not sure where to start? Here are a few ways to find your first contribution:
3131
**Tip:** Before working on a larger change, open an issue first to discuss your approach with the maintainers. This
3232
avoids unnecessary work and helps align your contribution with the project's direction.
3333

34+
## Before You Contribute
35+
36+
Before writing code, make sure your contribution has a home in an issue. This keeps the discussion visible to
37+
maintainers and other contributors and avoids duplicate or misaligned work.
38+
39+
- **Look for an existing issue** in the repository you want to contribute to. Someone may already be tracking the
40+
bug or feature you have in mind.
41+
- **If nothing matches, open a new issue** in the corresponding project to describe the problem or idea. Use it to
42+
clarify open points and agree on an approach with the maintainers before starting implementation.
43+
- **For larger or cross-cutting changes**, IronCore uses a central
44+
[enhancements repository](https://github.com/ironcore-dev/enhancements) where contributors submit
45+
**IronCore Enhancement Proposals (IEPs)**. An IEP is the place to describe the motivation, design, and trade-offs
46+
of a substantial idea or solution that affects one or more IronCore projects.
47+
- **Even for an IEP, start with an issue.** Especially for new contributors, please open an issue in the
48+
enhancements repository first to outline the idea and gather early feedback. This makes it much easier for
49+
maintainers to engage and for the proposal to land successfully.
50+
3451
## Making a Contribution
3552

3653
### Fork and Clone

0 commit comments

Comments
 (0)