Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Not sure whether to open an Issue or a Discussion? Use this guide:

### Open an Issue when:
- You found a **reproducible bug** — include version, environment, and steps to reproduce
- You have a **concrete feature request** — need is clearly defined with a specific use case
- You have a **small, concrete feature request** — well-scoped, no API or cross-repo impact

### Open a Discussion when:
- You have a **usage question** or need help → [Q&A](https://github.com/Mininglamp-OSS/community/discussions/categories/q-a)
- You have an **early-stage idea** to share → [Ideas](https://github.com/Mininglamp-OSS/community/discussions/categories/ideas)
- You have a **feature idea** — early-stage exploration or a significant proposal (public API change, cross-repo impact, new user-facing concept, notable UX/architecture) → [Ideas](https://github.com/Mininglamp-OSS/community/discussions/categories/ideas)
- You built something with Octo → [Show and tell](https://github.com/Mininglamp-OSS/community/discussions/categories/show-and-tell)
- You're not sure → open a Discussion; maintainers will convert it to an Issue if needed

Expand Down Expand Up @@ -78,10 +78,17 @@ Use the repository's **Bug Report** issue template. Include:

## Suggesting Features

Use the repository's **Feature Request** issue template. Describe:
- The problem you're trying to solve
- Your proposed solution
- Any alternatives you've considered
> **Significant features require a Discussion before an Issue.**
> See [GOVERNANCE.md](https://github.com/Mininglamp-OSS/community/blob/main/GOVERNANCE.md) for the full process.

1. **Open a Discussion** in the [Ideas](https://github.com/Mininglamp-OSS/community/discussions/categories/ideas) category of the community repository. A structured template is pre-filled automatically. Describe the problem, your proposed solution, and alternatives you considered.
2. **Discuss and refine.** Community members and the Project Lead will provide feedback. Iterate until there are no unresolved blocking concerns.
3. **The Project Lead marks the outcome.** Accepted Discussions are converted to a tracking Issue in the relevant repository, linked back to the Discussion. Declined or deferred outcomes are recorded with a rationale.
4. **The Issue is scheduled** on the [Octo Board](https://github.com/orgs/Mininglamp-OSS/projects) and implementation begins.

**What counts as "significant"?** Anything that changes a public API, adds a new user-facing concept, affects more than one repository, or has notable UX or architectural implications. Minor improvements, bug fixes, small ergonomic wins, and documentation updates may be filed directly as Issues using the **Feature Request** template.

Not sure which path to take? Open a Discussion — the Project Lead will guide you.

## Code of Conduct

Expand Down